diff options
Diffstat (limited to 'bitbake/doc/conf.py')
| -rw-r--r-- | bitbake/doc/conf.py | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/bitbake/doc/conf.py b/bitbake/doc/conf.py new file mode 100644 index 0000000000..1cac186d4b --- /dev/null +++ b/bitbake/doc/conf.py | |||
| @@ -0,0 +1,66 @@ | |||
| 1 | # Configuration file for the Sphinx documentation builder. | ||
| 2 | # | ||
| 3 | # This file only contains a selection of the most common options. For a full | ||
| 4 | # list see the documentation: | ||
| 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
| 6 | |||
| 7 | # -- Path setup -------------------------------------------------------------- | ||
| 8 | |||
| 9 | # If extensions (or modules to document with autodoc) are in another directory, | ||
| 10 | # add these directories to sys.path here. If the directory is relative to the | ||
| 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| 12 | # | ||
| 13 | # import os | ||
| 14 | # import sys | ||
| 15 | # sys.path.insert(0, os.path.abspath('.')) | ||
| 16 | |||
| 17 | import datetime | ||
| 18 | |||
| 19 | # -- Project information ----------------------------------------------------- | ||
| 20 | |||
| 21 | project = 'Bitbake' | ||
| 22 | copyright = '2004-%s, Richard Purdie, Chris Larson, and Phil Blundell' \ | ||
| 23 | % datetime.datetime.now().year | ||
| 24 | author = 'Richard Purdie, Chris Larson, and Phil Blundell' | ||
| 25 | |||
| 26 | |||
| 27 | # -- General configuration --------------------------------------------------- | ||
| 28 | |||
| 29 | # Add any Sphinx extension module names here, as strings. They can be | ||
| 30 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| 31 | # ones. | ||
| 32 | extensions = [ | ||
| 33 | 'sphinx.ext.autosectionlabel', | ||
| 34 | ] | ||
| 35 | autosectionlabel_prefix_document = True | ||
| 36 | |||
| 37 | # Add any paths that contain templates here, relative to this directory. | ||
| 38 | templates_path = ['_templates'] | ||
| 39 | |||
| 40 | # List of patterns, relative to source directory, that match files and | ||
| 41 | # directories to ignore when looking for source files. | ||
| 42 | # This pattern also affects html_static_path and html_extra_path. | ||
| 43 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
| 44 | |||
| 45 | # master document name. The default changed from contents to index. so better | ||
| 46 | # set it ourselves. | ||
| 47 | master_doc = 'index' | ||
| 48 | |||
| 49 | # create substitution for project configuration variables | ||
| 50 | rst_prolog = """ | ||
| 51 | .. |project_name| replace:: %s | ||
| 52 | .. |copyright| replace:: %s | ||
| 53 | .. |author| replace:: %s | ||
| 54 | """ % (project, copyright, author) | ||
| 55 | |||
| 56 | # -- Options for HTML output ------------------------------------------------- | ||
| 57 | |||
| 58 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| 59 | # a list of builtin themes. | ||
| 60 | # | ||
| 61 | html_theme = 'alabaster' | ||
| 62 | |||
| 63 | # Add any paths that contain custom static files (such as style sheets) here, | ||
| 64 | # relative to this directory. They are copied after the builtin static files, | ||
| 65 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
| 66 | html_static_path = ['_static'] | ||
