mirror of
https://review.coreboot.org/flashrom.git
synced 2025-04-26 22:52:34 +02:00
0b39a3e00c
This adds a build-time option to automatically generate a list of authors from git history, and includes it in the documentation by reading the output from git in a Sphinx extension. When git isn't available or the project source doesn't appear to be a git checkout, the list is not generated and gracefully replaced with a message explaining its absence. Change-Id: I1e9634a90e84262aafd80590deba9875f4b71a3c Signed-off-by: Peter Marheine <pmarheine@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/86350 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Anastasia Klimchuk <aklm@chromium.org>
57 lines
1.6 KiB
Python
57 lines
1.6 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 sys
|
|
|
|
from pathlib import Path
|
|
|
|
|
|
sys.path.append(str(Path('_ext').resolve()))
|
|
|
|
|
|
# -- 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',
|
|
'flashrom_authors'
|
|
]
|
|
|
|
#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']
|
|
|
|
html_favicon = 'logo/flashrom_icon_color-32x32.ico'
|
|
|
|
|
|
# -- Options for manual page output --------------------------------------------
|
|
man_make_section_directory = True
|
|
man_show_urls = True
|
|
man_pages = [
|
|
('classic_cli_manpage', project, '', [], 8),
|
|
]
|