Skip to content

Commit 97f02aa

Browse files
AnneHartebrodtAnneHartebrodt
committed
add docs
1 parent 9b8c839 commit 97f02aa

88 files changed

Lines changed: 1738 additions & 208 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/source/_templates/autosummary/function.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{{ fullname | escape | underline }}
2+
3+
.. currentmodule:: {{ module }}
4+
5+
.. autofunction:: {{ objname }}
6+

‎docs/source/_templates/autosummary/module.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{{ fullname | escape | underline }}
2+
3+
.. currentmodule:: {{ fullname }}
4+
5+
{# 1. Generate the module's own documentation #}
6+
.. automodule:: {{ fullname }}
7+
8+
{# 2. Look for functions INSIDE this file and give them pages #}
9+
{% block functions %}
10+
{% if functions %}
11+
.. rubric:: {{ _('Functions') }}
12+
13+
.. autosummary::
14+
:toctree: {# This line creates the function files #}
15+
:template: autosummary/function.rst
16+
:nosignatures:
17+
18+
{% for item in functions %}
19+
{{ item }}
20+
{% endfor %}
21+
{% endif %}
22+
{% endblock %}
23+
24+
{# 3. Look for classes INSIDE this file and give them pages #}
25+
{% block classes %}
26+
{% if classes %}
27+
.. rubric:: {{ _('Classes') }}
28+
29+
.. autosummary::
30+
:toctree:
31+
:template: autosummary/class.rst
32+
:nosignatures:
33+
34+
{% for item in classes %}
35+
{{ item }}
36+
{% endfor %}
37+
{% endif %}
38+
{% endblock %}
39+
40+
{# 4. Look for sub-packages/sub-modules if this is a directory #}
41+
{% block modules %}
42+
{% if modules %}
43+
.. rubric:: Modules
44+
45+
.. autosummary::
46+
:toctree:
47+
:recursive:
48+
:template: autosummary/module.rst
49+
50+
{% for item in modules %}
51+
{{ item }}
52+
{% endfor %}
53+
{% endif %}
54+
{% endblock %}

‎docs/source/api.rst‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
API Reference
2+
=============
3+
4+
.. autosummary::
5+
:toctree: generated
6+
:recursive:
7+
:template: autosummary/module.rst
8+
:nosignatures:
9+
10+
netmap

‎docs/source/conf.py‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@
99

1010
import os
1111
import sys
12-
sys.path.insert(0, os.path.abspath('../../')) # Adjust path to point to your app root
12+
sys.path.insert(0, os.path.abspath('../../src')) # Adjust path to point to your app root
1313

1414
project = 'Netmap'
1515
copyright = '2025, Anne Hartebrodt, Mhaned Oubounyt'
1616
author = 'Anne Hartebrodt, Mhaned Oubounyt'
17-
release = 'Jan, 2026'
17+
release = '0.1'
1818

1919
# -- General configuration ---------------------------------------------------
2020
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
2121
extensions = [
2222
'sphinx.ext.autodoc',
2323
'sphinx.ext.napoleon', # Highly recommended for Google/NumPy style docstrings
24-
'sphinx_rtd_theme',
24+
'sphinx.ext.autosummary',
2525
]
2626

2727
templates_path = ['_templates']
@@ -32,5 +32,12 @@
3232
# -- Options for HTML output -------------------------------------------------
3333
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
3434

35-
html_theme = 'alabaster'
35+
html_theme = 'furo'
3636
html_static_path = ['_static']
37+
38+
html_theme_options = {
39+
"sidebar_hide_name": False,
40+
"navigation_with_keys": True}
41+
42+
# This line is crucial for the :recursive: option to work!
43+
autosummary_generate = True

‎docs/source/generated/netmap.downstream.clustering.downstream_recipe.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
netmap.downstream.clustering.downstream\_recipe
2+
===============================================
3+
4+
.. currentmodule:: netmap.downstream.clustering
5+
6+
.. autofunction:: downstream_recipe

‎docs/source/generated/netmap.downstream.clustering.process.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
netmap.downstream.clustering.process
2+
====================================
3+
4+
.. currentmodule:: netmap.downstream.clustering
5+
6+
.. autofunction:: process

‎docs/source/generated/netmap.downstream.clustering.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
netmap.downstream.clustering
2+
============================
3+
4+
.. currentmodule:: netmap.downstream.clustering
5+
6+
7+
.. automodule:: netmap.downstream.clustering
8+
9+
10+
11+
12+
.. rubric:: Functions
13+
14+
.. autosummary::
15+
:toctree:
16+
:template: autosummary/function.rst
17+
:nosignatures:
18+
19+
20+
downstream_recipe
21+
22+
process
23+
24+
spectral_clustering
25+
26+
unify_group_labelling
27+
28+
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+

‎docs/source/generated/netmap.downstream.clustering.spectral_clustering.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
netmap.downstream.clustering.spectral\_clustering
2+
=================================================
3+
4+
.. currentmodule:: netmap.downstream.clustering
5+
6+
.. autofunction:: spectral_clustering

‎docs/source/generated/netmap.downstream.clustering.unify_group_labelling.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
netmap.downstream.clustering.unify\_group\_labelling
2+
====================================================
3+
4+
.. currentmodule:: netmap.downstream.clustering
5+
6+
.. autofunction:: unify_group_labelling

‎docs/source/generated/netmap.downstream.edge_selection.add_top_edge_annotation_cluster.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
netmap.downstream.edge\_selection.add\_top\_edge\_annotation\_cluster
2+
=====================================================================
3+
4+
.. currentmodule:: netmap.downstream.edge_selection
5+
6+
.. autofunction:: add_top_edge_annotation_cluster

0 commit comments

Comments
 (0)