Thanks to @StevePiercy I found this documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon conf.py html_favicon = ‘favicon.ico’ I put favicon.ico in my source folder, next to my .rst-files and it is working as expected: https://global-coffee-data-standard.readthedocs.io/en/latest/index.html
The only thing you need to host sphinx documentation is a static file server (the search works without a back end, see my answer here. That said, using a private readthedocs server is probably over-engineering. Just deploy the files to a static file server and point the base URL (e.g. docs.myapp.com) to the index.html file. … Read more
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
You can change add_module_names to False in the file conf.py: # If true, the current module name will be prepended to all description # unit titles (such as .. function::). add_module_names = False Then foo.bar.my_function() will display as my_function().
There is no way to tell Sphinx to exclude some imports. When using autodoc, all documented modules must be cleanly importable. You might be able to work around the problem by doing some mocking. Here is an article describing the solution to a problem that seems quite similar to yours: http://blog.rtwilson.com/how-to-make-your-sphinx-documentation-compile-with-readthedocs-when-youre-using-numpy-and-scipy/. Here is a small … 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
You could just use Read The Docs to host your documentation for you. They automatically handle multiple versions with a dropdown: https://docs.readthedocs.io/en/latest/index.html If you’d like to host your own documentation on GitHub Pages or some other web server, I made a Sphinx extension that does what you’re looking for: https://github.com/sphinx-contrib/sphinxcontrib-versioning
reStructuredText supports implicit hyperlink targets. From the reStructuredText quick reference: Section titles, footnotes, and citations automatically generate hyperlink targets (the title text or footnote/citation label is used as the hyperlink name). So the following text (lifted from the reStructuredText quick reference, spelling mistakes and all): Titles are targets, too ======================= Implict references, like `Titles are … Read more
If you have a look at :ref: documentation in its official web site about inline markups: :ref: To support cross-referencing to arbitrary locations in any document, the standard reST labels are used. For this to work label names must be unique throughout the entire documentation … I think (as @Kevin Horn) it’s no possible right … Read more
It sounds like you want to give the automodule directive a package name and have it recurse into the directory and document each Python module. That isn’t supported yet. You will ned to specify the full dotted module name for each module you want to document. For example, given the following directory structure (from the … Read more