Combine sphinx documentation from multiple projects
In our team, we have several projects, each of which is separately documented using sphinx. We want to have a central documentation page that includes all of our projects.
Of course, we could create an html page with links to different documents.
Is there a way to combine the documentation with Sphinx itself? Maybe with a separate Documentation project that somehow includes documentation from other projects?
source to share
You can try intersphinx for creating links between existing documents. This works as Wikipedia links to other Wikis in the Wikimedia universe.
An alternative is to check all documentation directories in the new repository. You may need to create a new one toctree
, because it either does not fit into the overall structure, or the nesting goes deep. Therefore, you can provide alternative index files by changing the name of the index file, eg. master.rst
...
Individual documentation is created using the original index.rst
, but if it is used in the main documentation, then only master.rst
files will be considered toctree
s.
source to share