Skip to content Skip to sidebar Skip to footer

Sphinx Does Not Recognize Subfolders

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 director

Solution 1:

You need to include the relative path to the .rst source file in the subdirectory.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   test
   dir1/file
   dir2/*

In dir1 only the file named file.rst would be included in the TOC. You can exclude files in there, too.

In dir2 all files would be included in the TOC via globbing syntax.

For further information, see documentation of the toctree directive.


Post a Comment for "Sphinx Does Not Recognize Subfolders"