Related softwareΒΆ
Doctr: A tool for automatically deploying docs from Travis CI to GitHub Pages. The
doctr-versions-menu
package works in conjunction with Doctr to inject a versions menu into the documentation.Sphinx: Documentation generator. While Doctr does not require the use of Sphinx, the
doctr-versions-menu
package works as a Sphinx extension, and is thus inherently tied to Sphinx.Read the Docs (RTD): Widely used documentation hoster. The motivation behind the
doctr-version-menu
is to provide a versions menu nearly identical to the one injected by RTD. As the versions menu indoctr-versions-menu
was reverse-engineered directly from the RTD menu,doctr-versions-menu
includes CSS develped by Read the Docs.Read the Docs Sphinx Theme: The recommended theme for Sphinx documentation (even when not hosted on http://readthedocs.org). While
doctr-versions-menu
should work to inject a versions menu into any theme, the original RTD theme best integrates the menu.