I want to use Sphinx's autosummary extension and templates to generate API docs recursively from docstrings. I want separate pages for each module, class, method, property and function. But it does...

I'm struggling with sidebar table of contents in Sphinx's generated documentation. I just want to have kind of automatically generated index tree by the left side of my documentation. Instead, I s...

I have many .rst files in my Sphinx tree which are intentionally excluded from any index tree. I get warnings like /filename.rst:: WARNING: document isn't included in any toctree How can I supp...

I have a toctree in my index.rst that looks something like this: .. toctree:: :maxdepth: 2 cat dog moose I am looking to to nest the contents of my toctree similar to how it is done here wi...

I want to do multiple versions of a documentation, which differ in the sections that are included. To achieve this I would usually use either the only directive or the ifconfig extension. However, ...

I am trying to automatically create api docs for a large python codebase using Sphinx. I have tried using build_modules.py and sphinx-apidoc. With either one, I can get rst docs successfully creat...

I'm getting the warning: WARNING: document isn't included in any toctree for files that exist in the document because they've been explicitly included. So I have the index file: .. toctree:: :max...

I'm generating html documentation in Sphinx. How do I modify the sidebar for each of the html pages in my document so that they include the toctree? By default the toctree only seems to display in...

Sphinx generates an index named genindex when building a documentation and therefore forbids to use that name for a document. Now, how would I include a link to that index in a table of contents? ...

In Sphinx docs, I define a reference document like this: Reference ========= .. toctree:: reference_api reference_cli reference_client reference_downloads reference_options reference_stats...

I was wondering if there is a way to expand all the subsections under the headers that are included in the index.rst file? As an example, here is how it is: Section 1 Section 2 Section 3 And he...

I'd like to have a link to the automatically generated index in the sidebar when using sphinx-rtd-theme. I've tried adding it to the toctree: .. toctree:: first second Index <:ref:`genindex...

I'm using sphinx with the numpydoc extension and autosummary. After some experimentation, I added the following options to my conf.py file. autosummary_generate = True numpydoc_show_class_members ...

If I have the following in index.rst: This Section ------------ .. toctree:: :caption: This Section :maxdepth: 1 this_section/intro this_section/body this_section/outro Then "This Sect...

I'm new to Sphinx and have been searching for a solution to this question for a while. My Index Page is made from index.rst which contains a toctree. The page displays the TOC in the body as well ...

I am using Sphinx to document a non-Python project. I want to distribute ./doc folders in each submodule, containing submodule_name.rst files to document that module. I then want to suck those file...

I am using Sphinx to create documentation for a Python module. I wold like to add subtitles on a page but I don't want them to appear in the toctree. I want small sections and short (few lines) des...

Is it possible to hide one (or all) subsections present in a RST file from the main TOCTree? Let me describe a little more: index.rst :doc:`Label <path/to/rst/file>` ^^^^^^^^^^^^^^^^^^^^^^...

I've got something like this: .. toctree:: :maxdepth: 2 :caption: Contents: :hidden: :glob: docs frontend backend tools/* I'd like all the documents found in the tools directory to collap...

I'm running into a problem in structuring my Sphinx users guide. I would like to form a chapter by having a main landing page (index.rst) that contains the chapter heading and an overview, and then...

I have some Sphinx based documentation for a library I built and I'd like to display the expanded table of contents for all my pages except for the changelog. I figured out how to do it by moving t...

I am having an issue with getting the table of contents (TOC) to display subsections of the front page of my documentation. I have a number of sections on my front page, and I would like these to ...

I have configured Sphinx to use markdown files. In my index.rst file I have .. toctree:: :maxdepth: 2 :caption: Contents: documents/Markdown In Markdown.md I have # Markdown ## H2 Head...

Trying to generate documentation with Sphinx. First using: sphinx-apidoc Then using: sphinx-build html And I got this warning about the modules.rst file. The file exists, the html is also generated...

I'm developing documentation in Sphinx, and would like to separate sections in my table of contents using horizontal bars. I often see this in menus: Is there a way to do it in sphinx?