1

I am creating documentation using Sphinx for my Django app.

To aid / reinforce information in the documentation, I have added my own source files (.rst) placed both in the root folder /docs/ and another folder /docs/modules/ like this:

docs/
    abc.rst
    <folders1, 2 ...>
    modules/
        about.rst
        extra_folder/
        xyz.rst
        quest.rst
        ......

Now I generated the docs using make html at the terminal and the docs are created which I am able to view in the browser. I can see the links to my .rst files on the page as well as can view the contents. Using the search field I can see that the search keys are correctly searched in documents wherever they are found (including my own .rst files).

However, when I visit the Index page, I find that:

  • There is no link to the pages created by me (e.g. abc.rst) i.e. my own pages are missing from the list of items displayed (if I were to click on A)
  • Even the key alphabet is missing. A case in point is that, the alphabet Q is missing altogether, though I have a source file quest.rst in my source file and has been included in the index.rst (under the toctree directive).

I tried this solution and this solution. However I am not able to generate the missing indices.

How should I approach this problem of missing Indices?

shaan
  • 351
  • 2
  • 15
  • 1
    Do you mean the file automatically generated by Sphinx with the filename of [genindex.html](https://www.sphinx-doc.org/en/master/genindex.html)? If so, these are index entries that are generated according to [Index-generating markup](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#index-generating-markup). – Steve Piercy Aug 09 '20 at 09:20
  • Please share your index.rst file contents and at least one file that is missing. What errors/warnings are reported by Sphinx? – Paebbels Aug 09 '20 at 19:02
  • 1
    @Paebbels - Thanks for writing. I have somehow been able to get behind the problem. Now the indices are coming correctly. The direction came from the page you had suggested. – shaan Aug 09 '20 at 19:06
  • 1
    Does this answer your question? [How can I link the generated index page in ReadTheDocs navigation bar?](https://stackoverflow.com/questions/40556423/how-can-i-link-the-generated-index-page-in-readthedocs-navigation-bar) – bad_coder Oct 03 '20 at 11:45

0 Answers0