[doc] question/enhancement-request on Sphinx theme used by openstack docs

Artem Goncharov artem.goncharov at gmail.com
Fri Jun 10 15:31:30 UTC 2022


Not in any way an advertisement, but we quite heavily reworked openstackdocstheme for our cloud (https://github.com/opentelekomcloud/otcdocstheme <https://github.com/opentelekomcloud/otcdocstheme> => https://docs-beta.otc.t-systems.com/otcdocstheme/ <https://docs-beta.otc.t-systems.com/otcdocstheme/>). We have updated to the latest bootstrap, fixed some of the layout issues, added right sidebar with local top and some other tunings. Our there is surely not to be reused by anybody else, but it may give you some hints what can be improved.


> On 10. Jun 2022, at 14:30, Waines, Greg <Greg.Waines at windriver.com> wrote:
> Hey … I am on the technical steering committee for the openstack starlingx team and also provide primary technical review for our docs at https://docs.starlingx.io/ <https://docs.starlingx.io/> .
> docs.starlingx.io <http://docs.starlingx.io/> basically uses the openstack docs team’s Sphinx theme for building our html docs … seehttps://opendev.org/starlingx/docs <https://opendev.org/starlingx/docs> .
> docs.starlingx.io <http://docs.starlingx.io/> is a very large doc suite.
> We are interested in improvements to the Table-of-Contents (TOC) navigation and presentation … but we have limited Sphinx expertise.
> Specifically we are looking for the TOC support to have
> - more subsection header levels in TOC
>          // such that user has full view of where he currently is in the doc hierarchy
> - highlighting to indicate currently selected section
> - separate scroll bar for TOC 
>          // ... so you don't lose sight of selected TOC selection when you scroll down on the main page which has large content.
> Have you ever considered such doc improvements?
> Did you have Sphinx expertise to do such improvements ?
> let us know,
> Greg.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20220610/c6f198e5/attachment-0001.htm>

More information about the openstack-discuss mailing list