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.10 and up are officially supported.
Running the tests
To run the tests, execute tox.
License
1 maintainer
Release files for sphinx-subprojecttoctree 0.6.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_subprojecttoctree-0.6.0.tar.gz | 219.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_subprojecttoctree-0.6.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 227.2 kB
Release files / sphinx_subprojecttoctree-0.6.0.tar.gz
| Download URL | sphinx_subprojecttoctree-0.6.0.tar.gz |
|---|---|
| Size | 219.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fa4282eb8032e44868bd16ecae02ee1a31d2c23c18d55c0ae5f11666a2a428c8
|
|
BLAKE2b-256 checksum How to use checksums |
6b41922b049af02e4ea4cfec99a89bb8d9233c6b6655a6d0ec74748e444943bf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.0
|
Release files / sphinx_subprojecttoctree-0.6.0-py3-none-any.whl
| Download URL | sphinx_subprojecttoctree-0.6.0-py3-none-any.whl |
|---|---|
| Size | 8.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58df8b330a587403e9460330febe26e25f3d04f815b31c0154cb6f1a488281b2
|
|
BLAKE2b-256 checksum How to use checksums |
605514a5efb99ad86e1ab605232e9a8de5af1119db9983d19b970400b799411d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.0
|
