xref: /aosp_15_r20/external/flashrom/doc/conf.py (revision 0d6140be3aa665ecc836e8907834fcd3e3b018fc)
1# Configuration file for the Sphinx documentation builder.
2#
3# For the full list of built-in configuration values, see the documentation:
4# https://www.sphinx-doc.org/en/master/usage/configuration.html
5
6import os
7
8# -- Project information -----------------------------------------------------
9# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
10
11project = 'flashrom'
12# copyright = '2023, The flashrom authors'
13author = 'The flashrom authors'
14
15# -- General configuration ---------------------------------------------------
16# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
17
18master_doc = 'index' # this is needed for old versions
19
20extensions = [
21    'sphinx.ext.todo'
22]
23
24#templates_path = ['_templates']
25exclude_patterns = []
26
27# -- Options for Todo extension ----------------------------------------------
28# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
29
30# If this is True, todo and todolist produce output, else they produce nothing. The default is False.
31todo_include_todos = False
32
33
34
35# -- Options for HTML output -------------------------------------------------
36# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
37
38html_theme = 'alabaster'
39#html_static_path = ['_static']
40
41html_favicon = 'logo/flashrom_icon_color-32x32.ico'
42
43
44# -- Options for manual page output --------------------------------------------
45man_make_section_directory = True
46man_show_urls = True
47man_pages = [
48    ('classic_cli_manpage', project, '', [], 8),
49]
50