Skip to content

Commit aac5da5

Browse files
authored
Merge pull request #114 from liuzhenqi77/fix-docs
2 parents 3b4b5df + bb251ab commit aac5da5

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ clean:
1818
rm -rf generated/
1919

2020
html-noplot:
21-
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
21+
$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
2222
@echo
2323
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
2424

docs/api.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,13 @@ Python Reference API
8484
:template: function.rst
8585
:toctree: generated/
8686

87+
sort_communities
8788
plot_mod_heatmap
8889
plot_conte69
89-
plot_point_brain
90+
plot_fslr
9091
plot_fsaverage
92+
plot_fsvertex
93+
plot_point_brain
9194

9295
.. _ref_stats:
9396

@@ -130,6 +133,7 @@ Python Reference API
130133

131134
communicability_bin
132135
communicability_wei
136+
rich_feeder_peripheral
133137

134138
.. _ref_datasets:
135139

docs/conf.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
# Add project name, copyright holder, and author(s)
1717
project = 'netneurotools'
18-
copyright = '2018, netneurotools developers'
18+
copyright = '2018-2022, netneurotools developers'
1919
author = 'Network Neuroscience Lab'
2020

2121
# Import project to get version info
@@ -62,7 +62,8 @@
6262
#
6363
# This is also used if you do content translation via gettext catalogs.
6464
# Usually you set "language" from the command line for these cases.
65-
language = None
65+
# https://github.com/sphinx-doc/sphinx/issues/10474
66+
# language = None
6667

6768
# List of patterns, relative to source directory, that match files and
6869
# directories to ignore when looking for source files.
@@ -83,7 +84,9 @@
8384
# Theme options are theme-specific and customize the look and feel of a theme
8485
# further. For a list of options available for each theme, see the
8586
# documentation.
86-
html_theme_options = {}
87+
html_theme_options = {
88+
"navigation_depth": 3
89+
}
8790

8891
# Add any paths that contain custom static files (such as style sheets) here,
8992
# relative to this directory. They are copied after the builtin static files,
@@ -100,7 +103,7 @@
100103

101104
# -- Extension configuration -------------------------------------------------
102105
intersphinx_mapping = {
103-
'python': ('https://docs.python.org/3.6', None),
106+
'python': ('https://docs.python.org/3', None),
104107
'matplotlib': ('https://matplotlib.org', None),
105108
'numpy': ('https://docs.scipy.org/doc/numpy', None),
106109
'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),

0 commit comments

Comments
 (0)