I am using Sphinx to generate pdf files from rst files. Sphinx automatically generates section numbers up to level 3 headings, as well as Table of Content up to this level. However, I want the head...

When working in PyCharm, the preview mode of the document I am creating in Sphinx shows: System Message: ERROR/3 (<stdin>, line 9) Unknown directive type "toctree". ..toctree:: ...

When inserting a document in a toctree, the link displayed is the main title of the document. So when I do: .. toctree:: materials/diffuse materials/glossy materials/specular I get: Material...

I have a directory containing various folders, with each of them having matlab source files in them. Some of these folders have sub-folders containing matlab source files. How can I create a TOC t...

Does anyone know any option to order toctree in descending order of the filenames? In case of ascending order, we can use :glob: option like this: .. toctree: :glob: 2011* This would be handy...

I am trying to get started with Sphinx for documenting Python, and I seem to be missing some very basic step in getting started. I'm following the http://www.sphinx-doc.org/en/stable/tutorial.htm...

I'm using the wonderful Sphinx tool to create some documentation and I'm trying to keep the codebase in a modular form by separating chapters of the same part into separate files. (See here for def...

I can render my Readme.md files in Sphinx using recommonmark. But when I try to put in multiple Readme files in a .rst file toctree only the first one can be accessed from the documentation link. ...

I'm new in using Sphinx. I'm able to create HTML documentations as long as my files are in the source top folder. As soon as I'm putting them in a subfolder in the source directory, Sphinx does n...

I used the sphinx-quickstart to set everything up. I used doc/ for the documentation root location. The folder containing my package is setup as: myfolder/ doc/ mypackage/ __init__.py moprob.py...

I am making a series of design documents in Sphinx and I would like to include them together in a toctree and have the sections within the documents numbered. I know that I can use .. sectnum:: to ...

The usual use of toctree in Sphinx looks something like this: .. toctree:: :maxdepth: 2 foo bar baz and if, for example, foo.rst starts with a title heading "Being Foo", bar.rst starts with...

I have an programmatically generated sphinx-doc source that uses the Read-The-Docs theme. The source tree looks like: source ├── conf.py ├── index.rst ├── models │   ├── 1lin │   │   ├── 1lin_Ampl...

I'm using Sphinx to build my documentation. I'm using other tool for API reference. I have my docs in a directory and the API reference in directory name api inside of it. I want to have a link fr...

I'm looking to increase the documentation in one of my libraries. I've been using sphinx to help build the documentation and recently started exploring the autodoc extension. It seems like in most...

I'm creating my documentation with Sphinx on ReadTheDocs, using their theme. The build process generates a genindex.html file, which can be referenced with: Link to the :ref:`genindex` page. whi...

I would like my toctree in sphinx to include the main (index.rst) page. The documents suggest that including 'self' will do this, but as others have noted on stackoverflow this only includes the ti...

Structure The following structure of the project: index.rst MyProject ========= Contents: .. toctree:: group1 group1.rst Group1 ------ Subgroup1 ========= Subgroup1 contents Subgroup2 ...

I have the following index.rst file. Know the cell population of your data ===================================== Some content .. toctree:: :maxdepth: 2 Installation ~~~~~~~~~~~~ .. toctree:: :...

I'm trying to use sphinx in a way to document multiple "levels" of documentation, eg: Api Reference Manual Tutorials Etc. The idea is that the Table of Contents is shown on the sidebar relative...

I have a .. toctree as part of a sphinx page, which includes relative links to other rst files in my package. How can I include a link to a subsection of a given page, rather than the full page its...

I'm not sure if this is possible. But I'm hoping to put multiple .rst files in a directory, and during compilation. I want these files to automatically be inserted in the toctree. How can I go abou...

It's my understanding the new Read The Docs theme generates the sidebar from the toctree with a depth of 2. My documentation is relatively deep, and a depth of 2 is not enough for it to be useful. ...

I'm using sphinx-apidoc and autosummary extensions to document an API for a library and I'm really unable to understand the purpose of the generated/ option below: .. autosummary:: :nosignatures:...

I have a Sphinx master document which includes child documents as follows: .. toctree:: :maxdepth: 2 :numbered: doc1 doc2 doc3 doc4 doc5 doc6 I would like to divide the TOC into parts ...