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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8126dbcce6d6bc4dfb29464b1e4bb093b42732c3c43543bbed93be149ab1e0f |
|
MD5 | c4cc0d4789765197dce8eaa91d8fac29 |
|
BLAKE2b-256 | 194716c9f69d17b022c1abf1b54060b94eb18a1ccb274ceabeb03275b2f119c2 |
Hashes for sphinx_subprojecttoctree-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 134d066f892ac18d5315a20fd9b7c1e54c64b26fe293f4d580e58e83209073b9 |
|
MD5 | 02afcbb47b47ffedc63b14d56999e195 |
|
BLAKE2b-256 | af623ecf448f0bba5d71ef984cb9fc8226bcc096f1174201d294aec6ac513730 |