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 <[email protected]> Reviewed-on: https://review.coreboot.org/c/flashrom/+/73359 Reviewed-by: Alexander Goncharov <[email protected]> Reviewed-by: Edward O'Callaghan <[email protected]> Reviewed-by: Anastasia Klimchuk <[email protected]> Tested-by: build bot (Jenkins) <[email protected]>
therealdreg · Apr 27, 2023 · 806a3fd · 806a3fd
1 parent 70af6ea
commit 806a3fd
Show file tree

Hide file tree

Showing 5 changed files with 271 additions and 148 deletions.
diff --git a/Documentation/building.md b/Documentation/building.md
diff --git a/doc/conf.py b/doc/conf.py
@@ -17,11 +17,19 @@
 
 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 -------------------------------------------------