pythonpython-sphinxglobtoctree

Using Sphinx to generate Python document using :glob:

I am new to Sphinx.

The file /home/user/myproject/docs/source/index.rst is as following:

My project contents:

.. toctree::
   :glob:

   *

I am getting the below message on running $ make html under /home/user/myproject/docs/:

checking consistency... /home/user/myproject/docs/source/design/index.rst:: WARNING: document isn't included in any toctree

What have I done wrongly? I would like Sphinx to automatically generate the structure depending on the directory hierarchy.

Solution

  • I don't think this is a supported operation.

    Fortunately, it's not a very desirable one either, since you generally want the parts of your documentation to appear in a particular order.