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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd3430c9eb4f99fa45fa47f23951ec5e88bf171949af271083516f6dfaf46f53 |
|
MD5 | 932ce99a537606a1a60ab81d48b5d338 |
|
BLAKE2b-256 | 052b46dbec8b09148821b360bca15a4e243976cbff0b076f5016a17532b448ee |
Hashes for sphinx_subprojecttoctree-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90fdcc0bbcedba696ab9d4df28fe6d29032601a5aecbf947645024c5f439b496 |
|
MD5 | 91bc72b750f73207fc2379235ef68645 |
|
BLAKE2b-256 | ec097148e35e0f2ea839b8bc245b88a89b6d567281a82261da63c973cf2380c4 |