| Message ID | 20190201145035.22739-6-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Enable build and install of our rST docs | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > Add the 'navigation' bar to the sidebar, which for some > reason is not enabled by default. Remove 'relations', which > is effectively disabled anyway and isn't useful for us. I'm not sure what the title means... is the theme a reference to a layout? I thought themes were colours and other such visual frippery rather than actual content layout. But what do I know as a mere code monkey... Reviewed-by: Alex Bennée <alex.bennee@linaro.org> > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > --- > docs/conf.py | 3 ++- > 1 file changed, 2 insertions(+), 1 deletion(-) > > diff --git a/docs/conf.py b/docs/conf.py > index e1d08a34a65..348e6358740 100644 > --- a/docs/conf.py > +++ b/docs/conf.py > @@ -106,7 +106,8 @@ html_theme = 'alabaster' > # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars > html_sidebars = { > '**': [ > - 'relations.html', # needs 'show_related': True theme option to display > + 'about.html', > + 'navigation.html', > 'searchbox.html', > ] > } -- Alex Bennée
On Fri, 1 Feb 2019 at 16:43, Alex Bennée <alex.bennee@linaro.org> wrote: > > > Peter Maydell <peter.maydell@linaro.org> writes: > > > Add the 'navigation' bar to the sidebar, which for some > > reason is not enabled by default. Remove 'relations', which > > is effectively disabled anyway and isn't useful for us. > > I'm not sure what the title means... is the theme a reference to a > layout? I thought themes were colours and other such visual frippery > rather than actual content layout. But what do I know as a mere code > monkey... Just noticed I never followed up to this. Sphinx themes allow a bit more customisation than just "colours and fonts": they can also do layout things like changing up what sorts of sidebar information is shown, or indeed whether there's any kind of sidebar at all. Specific themes might expose some theme-specific config options which allow tweaking of how they appear. http://www.sphinx-doc.org/en/stable/theming.html has a few screenshots and gives more of an idea of what sort of tweaks the theming system allows. thanks -- PMM
diff --git a/docs/conf.py b/docs/conf.py index e1d08a34a65..348e6358740 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -106,7 +106,8 @@ html_theme = 'alabaster' # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ - 'relations.html', # needs 'show_related': True theme option to display + 'about.html', + 'navigation.html', 'searchbox.html', ] }
Add the 'navigation' bar to the sidebar, which for some reason is not enabled by default. Remove 'relations', which is effectively disabled anyway and isn't useful for us. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) -- 2.20.1