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.10 and up are officially supported.
Running the tests
To run the tests, execute tox.
License
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_subprojecttoctree-0.6.0.tar.gz.
File metadata
- Download URL: sphinx_subprojecttoctree-0.6.0.tar.gz
- Upload date:
- Size: 219.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fa4282eb8032e44868bd16ecae02ee1a31d2c23c18d55c0ae5f11666a2a428c8
|
|
| MD5 |
690188e178f20baa8cbc89c8dfb6110e
|
|
| BLAKE2b-256 |
6b41922b049af02e4ea4cfec99a89bb8d9233c6b6655a6d0ec74748e444943bf
|
File details
Details for the file sphinx_subprojecttoctree-0.6.0-py3-none-any.whl.
File metadata
- Download URL: sphinx_subprojecttoctree-0.6.0-py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
58df8b330a587403e9460330febe26e25f3d04f815b31c0154cb6f1a488281b2
|
|
| MD5 |
c10d4697c1d6d80a047dc9e29d0d50ca
|
|
| BLAKE2b-256 |
605514a5efb99ad86e1ab605232e9a8de5af1119db9983d19b970400b799411d
|
