diff options
author | Thomas Heijligen <thomas.heijligen@secunet.com> | 2023-03-01 19:45:53 +0100 |
---|---|---|
committer | Anastasia Klimchuk <aklm@chromium.org> | 2023-04-27 09:41:58 +0000 |
commit | 806a3fd4d5d49c48116c9704d92d76cc2f5fb9d5 (patch) | |
tree | 1b18ab57f313fd4ddf6570f7c87a067e90766fa7 /doc/conf.py | |
parent | 70af6ea5c927a6b77d17ec2190e1df967016e993 (diff) | |
download | flashrom-806a3fd4d5d49c48116c9704d92d76cc2f5fb9d5.tar.gz flashrom-806a3fd4d5d49c48116c9704d92d76cc2f5fb9d5.tar.bz2 flashrom-806a3fd4d5d49c48116c9704d92d76cc2f5fb9d5.zip |
doc: Convert build documentation to sphinx
These build instructions are mostly based on `Documentation/building.md`
and the wiki.
There are some `.. todo::` sections still present in the
documentation. They will be completed later. For some of the todos
content needs to be written, some others require custom sphinx-plugins
to be implemented.
The `.. todo::` sections are only visible in the source, not in the
rendered html.
Change-Id: I96771e98b313a6d26dd2be940ff37998d4124324
Signed-off-by: Thomas Heijligen <thomas.heijligen@secunet.com>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/73359
Reviewed-by: Alexander Goncharov <chat@joursoir.net>
Reviewed-by: Edward O'Callaghan <quasisec@chromium.org>
Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'doc/conf.py')
-rw-r--r-- | doc/conf.py | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/conf.py b/doc/conf.py index 79d8aaec..77aa29b6 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -17,11 +17,19 @@ author = 'The flashrom authors' master_doc = 'index' # this is needed for old versions -extensions = [] +extensions = [ + 'sphinx.ext.todo' +] #templates_path = ['_templates'] exclude_patterns = [] +# -- Options for Todo extension ---------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html + +# If this is True, todo and todolist produce output, else they produce nothing. The default is False. +todo_include_todos = False + # -- Options for HTML output ------------------------------------------------- |