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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e47dc0330bfd54b13ecf8a01938e64473377724c3434b6df94a0834c6594a9f |
|
MD5 | f2b9d69b8b028e3191a6d701557c6609 |
|
BLAKE2b-256 | 76605e844472d9f59c345a336f01cd8a045314c96692145bdc60a0ce2d07a9a5 |
Hashes for sphinx_subprojecttoctree-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0499ff6d39ade858c1b16ca8301afc545134910304a1b8cf7a6147514ceb9035 |
|
MD5 | 4c6060339c41bead102dea0ea4719372 |
|
BLAKE2b-256 | 24596b97ef744f67322e8ed36d733735492536059774cdd45bec76cbb73f1b9a |