How to ensure that all Indices are corrected generated in Sphinx Documentation

半腔热情 提交于 2020-08-20 06:18:11

问题


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?

来源:https://stackoverflow.com/questions/63324232/how-to-ensure-that-all-indices-are-corrected-generated-in-sphinx-documentation

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!