diff options
author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-08 16:29:59 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-16 18:13:44 +0100 |
commit | cb19159cf8972713a2063387849804c5cea72d24 (patch) | |
tree | 5e2b95b1f9bbdc5bddfb0c4f29d4137441a6aa62 /doc/conf.py | |
parent | 10a54678bf7a119e91df8160b0f43384181d636d (diff) | |
download | bitbake-cb19159cf8972713a2063387849804c5cea72d24.tar.gz |
sphinx: Enhance the sphinx experience/nagivation with:
* Remove the pointless looking parts of breadcrumb navigtation
* Add a document type switcher to the breadcrumb navigation
* Add a version selection switch to the breadcrumb navigation
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Diffstat (limited to 'doc/conf.py')
-rw-r--r-- | doc/conf.py | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py index 4ff90e8db..722c79230 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -16,6 +16,15 @@ import datetime +current_version = "dev" + +# String used in sidebar +version = 'Version: ' + current_version +if current_version == 'dev': + version = 'Version: Current Development' +# Version seen in documentation_options.js and hence in js switchers code +release = current_version + # -- Project information ----------------------------------------------------- project = 'Bitbake' @@ -67,6 +76,7 @@ html_static_path = ['sphinx-static'] # Add customm CSS and JS files html_css_files = ['theme_overrides.css'] +html_js_files = ['switchers.js'] # Hide 'Created using Sphinx' text html_show_sphinx = False |