mrt134 / test-new-sphinx-theme Goto Github PK

Current search results aren't terribly useful. Finding ways to improve search functionality would be extremely useful:
Good/Bad/Terrible ideas:

• Clicking a search result takes the browser to the proper section/subsection.
• The search terms are highlighted in the text after clicking the search results link.
• When no results are available, display some kind of dialogue that has links to TrueOS Gitter, TrueOS Discourse, and/or the subReddit ("It seems your search found nothing here. The TrueOS project has subReddit and Discourse forums that discuss a wide variety of TrueOS topics.")

see trueos_style for exact formatting of search bar.

See trueos_style for exact settings for .. code-block:: none rendering

Add a basic image and verify using the .. figure:: foo directive works/renders properly.

see trueos_style for examples of colorblind friendly link colors.

There seems to be a bug with entries that are expandable. Clicking the entry without expanding it doesn't add the expected coloration for the currently active option.

Appearance should be invisible unless the table caption is hovered over (see header links for an example of the desired functionality).

Blue/gray color scheme is a little blah, adjusting to iX color schemes (see iX websites) may be a better option.

Be sure any colors contrast well with the TOC text, so entries are easy to read.

Apply trueos_style and view the html built document to view the needed colors.

Roles we use:
:file:foo
:command:foo
:kbd:Enter
:guilabel:foo
:menuselection:foo --> bar
:samp:# foo

Add these to the .rst file and build with the trueos_style theme for examples of the desired rendering.