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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc19fd4a8cfad97160882ddcdf0a8b5101fdd5c3a2ce9d452fbbe9a89565d07d |
|
MD5 | eebeea1ab730b28f1810a681efe42884 |
|
BLAKE2b-256 | 1bf9d0c9f8243f68d764a391f9d3e937d842c574e86d946e2e76a951d10ebae0 |
Hashes for sphinx_subprojecttoctree-0.5.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0e62685c6272892ddad33f808d67f1b6bba7e4180e9e22f55c10ed921ba8a2f |
|
MD5 | 06567a116a1e3fa31f6c2f3b304264fb |
|
BLAKE2b-256 | b399b1c8b64167971c6820fa5f67a92fda0c94c949dab7f8230c449139201114 |