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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f58c3117d8eb17e62f527743699788c5615ead6d2c38c5da6d8f6facd97d0da |
|
MD5 | 2658c9ba2f322c580723b61c962b9f8e |
|
BLAKE2b-256 | 99dd6f90938d29730d69d6a22fb87fb5c2808bc567acdc46b2c7aa65579c6815 |
Hashes for sphinx_subprojecttoctree-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b84f5d3edf2c10bcfa181497cc3975aca81969be6e11bc09a6b806b956be121 |
|
MD5 | 134c2f846bae200701127b337d5884ca |
|
BLAKE2b-256 | afde3abde887d5056c681cc955c8ddc9e46df95c972db43577b7be9cbb83ca52 |