-
Notifications
You must be signed in to change notification settings - Fork 12
Open
Labels
Description
This issue details a part of issue #130.
Parts of the documentation are almost hidden due to fontsizes, colors and lack of contrast.
- Titles in the menu should be more contrasted with the dark blue in the background.
- The page is not centered and a large area on the right side is lost (screen dependent, probably).
When I click on an item in the table of content (toc) on the left, and only when subsections exists, a small "+" appears, but it is not clear it provides more information.
For instance : If I click on "API documentation"
- 3 new subsections appears with a "+" : Main, Common low-level functions, From OpenTURNS to FMI
- These 3 titles are in the page "API documentation", and I understood subsections in the toc are links to these parts of these pages.
- But, if I click on the "Main API", it is not a link to a section anymore, but a page containing new information.
I think there is a risk of missing important elements in the documentation due to these kind of interaction.
- Symbol to fold and unfold page too small and not distinguishable enough.
- Confusion due to unexpected change of interaction : unfold section leads to links to page's section, but it unfolds other subsubsections, which are now dedicated pages.
Proposal :
- find a new template and color scheme to make all element more visible and harmonious, with more contrast and space. Examples :
https://pandas.pydata.org/docs/
https://www.sphinx-doc.org/en/master/index.html
https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html
- Use more often "directives" provided by Sphinx to organize section, ideas, blocks, figure.
Reactions are currently unavailable