openwrt/flashrom
1
0
Fork 0
mirror of https://review.coreboot.org/flashrom.git synced 2025-07-02 06:23:18 +02:00
Code Issues Releases Wiki Activity

doc: Convert build documentation to sphinx

Browse Source 
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>
This commit is contained in:
Thomas Heijligen
2023-03-01 19:45:53 +01:00
committed by Anastasia Klimchuk
parent 70af6ea5c9
commit 806a3fd4d5
5 changed files with 271 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/conf.py
View File

@ -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 -------------------------------------------------