Skip to content

Commit 29e7d93

Browse files
committed
rejigger the whole API toctree, and name "Module contents" to "Core API" in the main package
1 parent 713caf4 commit 29e7d93

4 files changed

Lines changed: 4 additions & 9 deletions

File tree

Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,6 @@ doc:
1515
rm -rf docs/build
1616
rm -rf docs/source/api
1717
cd docs; sphinx-apidoc -e -o source/api ../effect ../setup.py ../examples ../effect/test_*.py
18+
rm docs/source/api/modules.rst
19+
sed -i '' -e 's/Module contents/Core API/' docs/source/api/effect.rst
1820
cd docs; PYTHONPATH=..:$(PYTHONPATH) sphinx-build -W -b html -d build/doctrees source build/html

docs/source/api/effect.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Submodules
1414
effect.testing
1515
effect.threads
1616

17-
Module contents
17+
Core API
1818
---------------
1919

2020
.. automodule:: effect

docs/source/api/modules.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ API
1616
Effect comes with thorough API documentation.
1717

1818
.. toctree::
19-
:maxdepth: 2
19+
:maxdepth: 3
2020

2121
api/effect
2222

0 commit comments

Comments
 (0)