Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Combine Sphinx documentation from several Projects

In our team we have several Projects, each separately documented with Sphinx. We want to have a central documentation page, which includes all of our projects.

Of course we could build a HTML page with links to the different documentations.

Is there a way to combine the documentations with Sphinx itself? Maybe with a separate Documentation project, which somehow includes the documentation from the other projects?

like image 251
Igle Avatar asked Jul 17 '17 06:07

Igle


People also ask

What is Intersphinx?

New in version 0.5. This extension can generate links to the documentation of objects in external projects, either explicitly through the external role, or as a fallback resolution for any other cross-reference.

What is Sphinx markdown?

Markdown is a lightweight markup language with a simplistic plain text formatting syntax. It exists in many syntactically different flavors. To support Markdown-based documentation, Sphinx can use MyST-Parser.


Video Answer


1 Answers

You could try intersphinx to create links between existing documentations. This works like Wikipedia links to other Wikis in the Wikimedia universe.

An alternative is to checkout all documentation directories into a new repository. You might need to create new toctrees because it either doesn't fit into the overall structure or the nesting gets to deep. Therefore you could provide alternative index files by changing the index file name to e.g. master.rst.

An individual documentation is build by using the original index.rst but if it's used in the master documentation, only master.rst files will be considered as toctrees.

like image 119
Paebbels Avatar answered Oct 20 '22 05:10

Paebbels