mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-27 23:22:37 +02:00
806a3fd4d5
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>
49 lines
1.5 KiB
Python
49 lines
1.5 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
import os
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
|
|
project = 'flashrom'
|
|
# copyright = '2023, The flashrom authors'
|
|
author = 'The flashrom authors'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
master_doc = 'index' # this is needed for old versions
|
|
|
|
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 -------------------------------------------------
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
html_theme = 'alabaster'
|
|
#html_static_path = ['_static']
|
|
|
|
|
|
|
|
# -- Options for manual page output --------------------------------------------
|
|
man_make_section_directory = True
|
|
man_show_urls = True
|
|
man_pages = [
|
|
('classic_cli_manpage', project, '', [], 8),
|
|
]
|