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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a4b352304614bda3a6e7fe4a39ce757099ee0bd8802645032b4455b4a2c926a |
|
MD5 | 1b425fa039fc156f6233944af7674baa |
|
BLAKE2b-256 | 8ab80c55f75216108e542d7e00d74aa05aa16e4d0876d7a3ce4b1e685430415d |
Hashes for sphinx_subprojecttoctree-0.5.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89e03dd79b7d5992335eb2b213e84f34cb8bf7e503f6a34dfd82e74efc5e05dc |
|
MD5 | 7395d28b2f3aef4738742cd0f1810571 |
|
BLAKE2b-256 | f01b7127e9caaafa55bf56cc5b175958e0cc9f2c51396d062adbf85a0b2661ee |