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
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.4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 377d88ec7c832e578d41777af86d48990da75591976d98b45591de46356e615f |
|
| MD5 | 8bc19dba917bc9f5a57eb15bec46a318 |
|
| BLAKE2b-256 | 06c7a9ccb48e0c7a222cc871ce213b46b79659b4ccd459209dd449d4559698ae |
Hashes for sphinx_subprojecttoctree-0.5.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eef3ddc8548ac1c7213ce00a1931c3f9370c5c243ca571f7ce12f0444e3b0f79 |
|
| MD5 | 58b269b012f85e2b53dc5796ddade614 |
|
| BLAKE2b-256 | 0ead70ea9d1959741716c2bb81bee025eae73de03b97747dc3b026eacebffee7 |
