From 806a3fd4d5d49c48116c9704d92d76cc2f5fb9d5 Mon Sep 17 00:00:00 2001 From: Thomas Heijligen Date: Wed, 1 Mar 2023 19:45:53 +0100 Subject: 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 Reviewed-on: https://review.coreboot.org/c/flashrom/+/73359 Reviewed-by: Alexander Goncharov Reviewed-by: Edward O'Callaghan Reviewed-by: Anastasia Klimchuk Tested-by: build bot (Jenkins) --- doc/conf.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'doc/conf.py') 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 ------------------------------------------------- -- cgit v1.2.3