Subprojecttoctrees is a Sphinx extension that aims to facilitate the integration of several documentation sources into a single Read the Docs webpage.
Project description
Subprojecttoctree
Subprojecttoctrees is a Sphinx extension that aims to facilitate the integration of several documentation sources into a single Read the Docs webpage. This project extends the Read the Docs subproject concept, which allows projects to be configured as a subproject of another project, by creating a unified sidebar of URLs between these projects. A single 'master' index is specified in the 'main' project, eliminating the need to update all subprojects to change the index and allowing for version-specific sidebar links.
Documentation
The documentation can be found here.
How to install
Before installing, it is recommended to create a virtual environment first. Learn more about virtual environments here.
You can install binairy packages from the Python Package Index (PyPI)
pip install sphinx-subprojecttoctree
More information can be found in the documentation
Dependencies
This project is a plugin for Sphinx.
Python version support
Python 3.8, 3.9 and 3.10 are officially supported.
Running the tests
To run the tests, execute tox
.
License
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
Built Distribution
Hashes for sphinx-subprojecttoctree-0.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02e48103a827ae34c540afb1b882adf77555f0072863afd40a21f2246965e1b0 |
|
MD5 | f369b151c9a697d4cece38ba6846be36 |
|
BLAKE2b-256 | 49060342bcb3042be605226a33d1d430fd15c7f8ace07737bc95084d3485d392 |
Hashes for sphinx_subprojecttoctree-0.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6f2c25a0db0e241c3e3f87de5887b06682757fb875604d0a983fe4109f9e297 |
|
MD5 | c22aef03f849f64096cf0fb98e5fb6eb |
|
BLAKE2b-256 | 86fef26c2e3aec2eeddfdf8ebd58b07edabf57a5ab0616ed46f521340ab879c6 |