#915 - Refactored documentation and included APi docs, dependencies.
- make files now re-build autosummary and deps file. - Added typer and platformdirs to deps in pyproject.toml. - Made root_is_pure = True in setup.py as platform/python specific wheels don't need to be built but the option is there should we need to. - Added an e2e test for primaite.main.run func.
This commit is contained in:
16
docs/api.rst
Normal file
16
docs/api.rst
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user