NG: Switch to modern responsive 3-column layout theme sphinx-basic-ng
#390
Conversation
ProgressWith header and footerNow also uses CSS directive
With contentContent, page tools, and version chooser have been migrated. -- 8f63c8e
With primary sidebarFor demonstration purposes, it displays an automatically generated navigation tree, as well as the custom semi-static menu provided by the theme. -- 261e5d2, 7d6f812, fb67ada
The navigation tree is generated using Furo's With secondary sidebarDisplay the page's toc within the secondary sidebar / right navigation, and make sure the sidebar toggles work. -- 1664079
|
amotl
force-pushed
the
amo/basic-ng
branch
2 times, most recently
from
abe6c12
to
1664079
Compare
| /* Attempt to fix jumping border */ | ||
| /* | ||
| details.sd-dropdown:not([open]).sd-card | ||
| border: 1px solid transparent | ||
| */ |
There was a problem hiding this comment.
This suggestion by @msbt improves the border jumping, but introduces other wobbles, slightly worse, so it has not been used yet.
amotl
force-pushed
the
amo/basic-ng
branch
2 times, most recently
from
34bba3b
to
6bc6edc
Compare
amotl
changed the title
sphinx-basic-ngsphinx-basic-ng
|
Hi again. @msbt contributed significantly to this patch. Thank you very much! We will integrate those improvements here, and run a devX release, in order to be able to slap the new theme on a few downstream projects in preview mode. |
This theme derives from [sphinx-basic-ng], but needs a few components from [Furo]. For example, the menu builder from Furo's `navigation.py` is made available to the HTML context via `ng_navigation_tree`. Therefore, it needs to vendorize a few styles. It can not take the whole thing, because Furo's colors currently interfere with the colors provided by the theme's styles. [Furo]: https://github.com/pradyunsg/furo [sphinx-basic-ng]: https://github.com/pradyunsg/sphinx-basic-ng
For demonstration purposes, it displays an automatically generated navigation tree, as well as the custom semi-static menu provided by the theme. The navigation tree is generated using Furo's `compute_navigation_tree`.
A few sections may require more depth. Let's probe how this could make a difference.
|
Originally submitted on Jul 22, 2023, more than a year ago, this was quite a long-running patch once again, traveling through marvellous journeys in exciting times. Thank you so much for your support to make it converge well. We hope all relevant/important teething issues have been resolved so far. If you can spot any other rendering flaws or other misbehaviours, or if you want to share suggestions for further improval, please tell us on a ticket here, or on company Slack. Thank you. |
About
The foundation of the current page design is based on Sphinx' original
basic/layout.html, Copyright 2007-2014 by the Sphinx team, so it is already 16 years old, and deserves a modernization.Following up on GH-378, this patch starts deriving from sphinx-basic-ng, in order to bring in more thorough modernizations, also on the page layout level.
Preview
https://crate-docs-theme--390.org.readthedocs.build/en/390/
Details
It starts with an empty scaffolded canvas. -- 62f971d
/cc @surister, @simonprickett