mirror of
https://review.coreboot.org/flashrom.git
synced 2025-10-24 19:18:20 +02:00
c54d068418
This is especially important for manpage, but also any other document which has examples of command-line usage. On the actual command line the options are with -- and so it should be in documentation. The option also disables smart quotes, but this doesn't matter for flashrom documentation. Change-Id: I94531c9b7471c5c26dd92ddcce5b0588af9207fd Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/89633 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Peter Marheine <pmarheine@chromium.org>
59 lines
1.7 KiB
Python
59 lines
1.7 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'
|
|
|
|
# This disables auto-converting -- to en-dash, which we don't want for classic_cli_manpage.html
|
|
smartquotes = False
|
|
|
|
# -- Options for manual page output --------------------------------------------
|
|
man_make_section_directory = True
|
|
man_show_urls = True
|
|
man_pages = [
|
|
('classic_cli_manpage', project, '', [], 8),
|
|
]
|