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 as as 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.

Contents:

• Installation
  • Installation using pip
  • Installation from source
• User Guide
  • Quickstart
  • Example
  • Sphinx configuration
  • The subprojecttoctree directive
  • Read the Docs Setup (Online builds)
  • Local builds
  • Creating links between the projects
• Changelog
  • 0.5.5 (in development)
  • 0.5.4 (25/08/2023)
  • 0.5.3 (15/06/2023)
  • 0.5.2 (12/11/2022)
  • 0.5.1 (11/11/2022)
  • 0.5.0 (9/11/2022)
  • 0.4.0 (30/08/2022)
  • 0.3.1 (5/05/2022)
  • 0.3.0 (5/05/2022)
  • 0.2.0 (17/02/2022)
  • 0.1.4 (11/02/2022)
  • 0.1.3 (11/02/2022)
  • 0.1.2 (11/02/2022)
  • 0.1.1 (10/02/2022)
  • 0.1.0 (10/02/2022)