Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme is repeated twice in the docs #2330

Closed
purva-thakre opened this issue Apr 27, 2024 · 0 comments · Fixed by #2362
Closed

Readme is repeated twice in the docs #2330

purva-thakre opened this issue Apr 27, 2024 · 0 comments · Fixed by #2362
Assignees
Labels
documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on.

Comments

@purva-thakre
Copy link
Collaborator

purva-thakre commented Apr 27, 2024

Previously discussed here: #2278 (comment)

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 from readme.md.

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.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree

readme.md

```{include} ./readme.md
```


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.

For example, see the bottom right corner of https://mitiq.readthedocs.io/en/v0.34.0/index.html
image

This option is available on other pages of the latest version of the docs (bottom left), just not on the main page.
image

@purva-thakre purva-thakre added documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on. labels Apr 27, 2024
@jordandsullivan jordandsullivan self-assigned this May 10, 2024
@jordandsullivan jordandsullivan linked a pull request May 10, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation non-quantum Requires no knowledge of quantum physics to fix / work on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants