diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 00000000..df2bc193 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,16 @@ +.. + DO NOT DELETE THIS FILE! It contains the all-important `.. autosummary::` directive with `:recursive:` option, without + which API documentation wouldn't get extracted from docstrings by the `sphinx.ext.autosummary` engine. It is hidden + (not declared in any toctree) to remove an unnecessary intermediate page; index.rst instead points directly to the + package page. DO NOT REMOVE THIS FILE! + + Credit to https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion for the custom templates. +.. + +.. autosummary:: + :toctree: source/_autosummary + :template: custom-module-template.rst + :recursive: + + primaite + tests