Are there .rst files in your Sphinx project whose content you don’t want in the output? Use the exclude_patterns configuration variable. No output (and no warning messages) will be generated for files matching the specified patterns. See http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-exclude_patterns. Are there .rst files in your Sphinx project that are not part of any toctree but whose … Read more
Turns out the answer was hiding in plain sight on Sphinx’s TOC tree page: The special entry name self stands for the document containing the toctree directive. This is useful if you want to generate a “sitemap” from the toctree. Adding self to the TOC tree did the trick perfectly! And if you place it … Read more
Well, i lost approximately 3.4M neurons trying to read sphinx source code (was it written by a bunch of rabbid reckless raccoons ?! so many levels of abstraction). So : make your own sphinx theme (use a 3rd party theme as a base, very easy. I use ‘readable’ theme for that) in the directory where … Read more
You can customize your html sidebar in conf.py. The default html sidebar consists of 4 templates: [‘localtoc.html’, ‘relations.html’, ‘sourcelink.html’, ‘searchbox.html’] In conf.py you could change localtoc.html to globaltoc.html like this: html_sidebars = { ‘**’: [‘globaltoc.html’, ‘relations.html’, ‘sourcelink.html’, ‘searchbox.html’] } Since this in the end this will be used in HTML files, this should work on … Read more
Sorry for such a late answer (if it can be considered that) but I found this link that discusses what may be happening to you: https://github.com/phn/pytpm/issues/3#issuecomment-12133978 The idea that if you have some special Doc scraper in your documentation code that is building autosummary documentation after autosummary has already run may be something to look … Read more
If you only want to ..include:: a document in another document, without having it appear in any toctree. Add :orphan: to the top of your document to get rid of the warning. This is a File-wide metadata option. Read more from the Sphinx documentation.
Yes, you can! In lieu of a symlink (which won’t work on Windows), create a stub document that has nothing in it but a .. include:: directive. I ran into this trying to link to a README file that was in the top of the source tree. I put the following in a file called … Read more