Skip to content

Commit 5346e1c

Browse files
committed
docs: final touches to structure of API
1 parent a2a4bf8 commit 5346e1c

File tree

4 files changed

+14
-2
lines changed

4 files changed

+14
-2
lines changed

docs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ help:
5252
clean:
5353
rm -rf $(BUILDDIR)/*
5454
rm -rf reference/*
55+
rm -rf api/*
5556

5657
html:
5758
PYTHONPATH=$(PYTHONPATH) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

docs/api.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Library API (application program interface)
2+
===========================================
3+
4+
Information on specific functions, classes, and methods.
5+
6+
.. toctree::
7+
8+
api/templateflow.api
9+
api/templateflow.conf

docs/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@
8888
# List of patterns, relative to source directory, that match files and
8989
# directories to ignore when looking for source files.
9090
# This pattern also affects html_static_path and html_extra_path.
91-
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'api/modules.rst']
91+
exclude_patterns = [
92+
'_build', 'Thumbs.db', '.DS_Store',
93+
'api/modules.rst', 'api/templateflow.rst']
9294

9395
# The name of the Pygments (syntax highlighting) style to use.
9496
pygments_style = None

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Contents
1111

1212
naming
1313
tutorials
14-
api/templateflow
14+
api
1515

1616
What's new
1717
----------

0 commit comments

Comments
 (0)