Task #4025
Updated by dkliban@redhat.com over 5 years ago
One of the suggestions from the Pulp Community Health Audit was to make the documentation easier to discover/navigate. One of the problems is that when a user clicks on the 'documentation' link in the menu on pulpproject.org, the user is taken to a page where a specific version of docs has to be selected. If the user selects the wrong version of docs, then he has to go back to the first page and select a different version. The user would have a better experience if he could select which version of docs to view using a selector present on every page of the docs. The current theme[0] that we use for our docs does not have such a feature, but a feature like that has been developed for it and is available in a form of a pull request[1].
We should try to add something similar to the code in the PR to the template we are using for our theme on both Pulp 2 and Pulp 3.
Other projects rely on sphinx-contrib-versioning[2]. However, I don't think it's compatible with how we build our docs for Pulp 2. Though I may be mistaken.
[0] https://github.com/rtfd/sphinx_rtd_theme
[1] https://github.com/rtfd/sphinx_rtd_theme/pull/438
[2] https://robpol86.github.io/sphinxcontrib-versioning/index.html
.