Commit Graph

8 Commits

Author SHA1 Message Date
Andrei Gherzan
98ee0439ca docs: Fix documentation theme
This avoids failing builds with:
NameError: name 'html_theme' is not defined

It also makes the theme configuration explicit and correctly set up.

Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2023-08-29 22:43:01 +01:00
Andrei Gherzan
ad6ebc053a docs: Bump copyright year
Signed-off-by: Andrei Gherzan <andrei.gherzan@huawei.com>
2022-04-21 21:41:38 +01:00
Andrei Gherzan
dc2c0b8197
docs: Fix RtD build
Markdown parser has changed[1].

[1] https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html#using-markdown-with-sphinx

Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 00:32:53 +00:00
Andrei Gherzan
361df89060
docs: Bump copyright year
Signed-off-by: Andrei Gherzan <andrei@gherzan.com>
2021-11-14 00:19:58 +00:00
Martin Jansa
3f703e1b1d Manually fix conversion
Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
2021-08-04 12:30:12 +03:00
Martin Jansa
9ea7aa2cd2 Convert to new override syntax
This is the result of automated script conversion:

oe-core/scripts/contrib/convert-overrides.py .

converting the metadata to use ":" as the override character instead of "_".

Signed-off-by: Martin Jansa <Martin.Jansa@gmail.com>
2021-08-04 12:30:12 +03:00
Paul Barker
24ffe9fb59 docs: Do not force alabaster theme
Sphinx will use the 'alabaster' theme by default when building locally. However,
Read the Docs will use their own theme by default which suits their site better.

By not specifying html_theme we allow both targets to use the appropriate
default theme.

Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-12-18 19:20:43 +00:00
Paul Barker
654d84d68a docs: Initial sphinx configuration
This allows us to create documentation by running 'make html' or 'make
latexpdf' in the docs directory. It depends on sphinx and the
recommonmark python module (for parsing markdown files in sphinx).
Creation of the PDF document requires a full LaTeX toolchain to be
installed.

Signed-off-by: Paul Barker <pbarker@toganlabs.com>
2017-05-26 12:16:52 +01:00