summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* bitbake: doc/conf.py: add missing import sysMert Kirpici2020-11-201-0/+1
| | | | | | | | | | | Due to the calls to sys.stderr.write() and sys.exit() in exception handling in case of sphinx_rtd_theme not being installed, the following exception is raised by Python due to the fact that sys module not being imported. (Bitbake rev: 5ddf0e5bee0de59d07295fc5693e20b1a0380fde) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: docs: sphinx: report errors when dependencies are not metNicolas Dechesne2020-10-061-1/+7
| | | | | | | (Bitbake rev: 9ae5cce76693d7c12396cee1183aaf371bb3d66c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: conf: enable extlinks extensionNicolas Dechesne2020-09-161-0/+6
| | | | | | | (Bitbake rev: 3e940d93c7513413a93a910122b1dd82870044b1) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: Enhance the sphinx experience/nagivation with:Richard Purdie2020-09-161-0/+10
| | | | | | | | | | | | * 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 (Bitbake rev: cb19159cf8972713a2063387849804c5cea72d24) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org> Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: tweak html output a bitNicolas Dechesne2020-09-161-5/+11
| | | | | | | | | | | * Remove the 'generated by Sphinx' text on each page * Add a 'last updated timestamp' on each page * Remove the trailing 'dot' in TOC numbering (Bitbake rev: 10a54678bf7a119e91df8160b0f43384181d636d) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: override theme CSSNicolas Dechesne2020-09-161-1/+7
| | | | | | | | | | | | | It is possible to override CSS settings from the theme, by providing custom snippets of CSS stylesheet. Support for that is added in conf.py file. Most of the CSS customization is inherited from the DocBook CSS style. (Bitbake rev: fa304c0129538d7a0b7a3922cd1fde2e242d6cab) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: switch to readthedocs themeNicolas Dechesne2020-09-161-1/+1
| | | | | | | | | | To install this additional theme: pip3 install sphinx_rtd_theme (Bitbake rev: 29af1cd2a4f379096f5dd6f4cacc0a9c9f211e7c) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bitbake: sphinx: add initial build infrastructureNicolas Dechesne2020-09-161-0/+66
Used sphinx-quickstart to generate top level config and Makefile.sphinx, to allow side by side DocBook and Sphinx co-existence. (Bitbake rev: 84ccba0f4aff91528f764523fe1205a354c889ed) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>