I think this is because we use readme in the toctree directive and an include directive again for the readme. One of these has to be removed. I don't really know which of the two is important for the home page but a SO answer does use the include directive for the home page.
The current home page also does not let you access earlier versions of the docs. Which is why I am not too sure which of the two directives should be used: toctree or include
Earlier versions of the docs were accessible from the main landing page of https://mitiq.readthedocs.io/ but this option is no longer available on the main page after the theme was changed.
Previously discussed here: https://github.com/unitaryfund/mitiq/issues/2278#issuecomment-2077751053
If you go to the main page of the documentation, the information is from
readme.md
. But scroll to the bottom and navigate to the next page and we once again see the information fromreadme.md
.I think this is because we use readme in the
toctree
directive and aninclude
directive again for the readme. One of these has to be removed. I don't really know which of the two is important for the home page but a SO answer does use theinclude
directive for the home page.https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree https://github.com/unitaryfund/mitiq/blob/9e1cbb5a134983f247f1ed74cbe932a0156e76d1/docs/source/index.md?plain=1#L8 https://github.com/unitaryfund/mitiq/blob/9e1cbb5a134983f247f1ed74cbe932a0156e76d1/docs/source/index.md?plain=1#L16-L18
The current home page also does not let you access earlier versions of the docs. Which is why I am not too sure which of the two directives should be used:
toctree
orinclude
Earlier versions of the docs were accessible from the main landing page of https://mitiq.readthedocs.io/ but this option is no longer available on the main page after the theme was changed.
For example, see the bottom right corner of https://mitiq.readthedocs.io/en/v0.34.0/index.html
This option is available on other pages of the latest version of the docs (bottom left), just not on the main page.