Sphinx extension to auto-generate API tree.
Project description
sphinx-apitree
apitree
is a small library to generate a ready-to-use documentation with minimal friction!
apitree
takes care of everything, so you can only focus on the code.
Usage
In docs/conf.py
, replace everything by:
import apitree
apitree.make_project(
project_name='my_module',
globals=globals(),
)
Then to generate the doc:
sphinx-build -b html docs/ docs/_build
To add api/my_module/index
somewhere in your toctree, like:
..toctree:
:caption: API
api/my_module/index
Features
- Theme
- Auto-generate the API tree, with better features
- Do not require
__all__
- Add expandable toc tree with all symbols
- Do not require
- ...
Installation in a project
-
In
pyproject.toml
[project.optional-dependencies] # Installed through `pip install .[docs]` docs = [ # Install `apitree` with all extensions (sphinx, theme,...) "sphinx-apitree[ext] @ https://github.com/conchylicultor/sphinx-apitree", ]
-
In
.readthedocs.yaml
sphinx: configuration: docs/conf.py python: install: - method: pip path: . extra_requirements: - docs
Examples of projects using apitree
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-apitree-1.0.0.tar.gz
(16.0 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_apitree-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2eb0e25309ba8d7a943e999edf39dace891769f18f31e66e19a16f1e00f04dfc |
|
MD5 | 7009e3debee15d418325d540934ce65d |
|
BLAKE2b-256 | 6c9b24972dd91a4ba1f7d1b3d9ba0181c9e900dbe3714b3f9f19139de322b38b |