summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/conf.py
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-05-26 19:14:48 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-16 18:14:07 +0100
commit69ed72025ad48ef042bb80cdc912c8486cf635bc (patch)
tree01e0bd54a302ee6f8e94fb377e6fb27fbae36d5d /bitbake/doc/conf.py
parent42bbf1451ac67675de52f7dc0285b1f3bb24216b (diff)
downloadpoky-69ed72025ad48ef042bb80cdc912c8486cf635bc.tar.gz
bitbake: sphinx: add initial build infrastructure
Used sphinx-quickstart to generate top level config and Makefile.sphinx, to allow side by side DocBook and Sphinx co-existence. (Bitbake rev: 84ccba0f4aff91528f764523fe1205a354c889ed) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/conf.py')
-rw-r--r--bitbake/doc/conf.py66
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
17import datetime
18
19# -- Project information -----------------------------------------------------
20
21project = 'Bitbake'
22copyright = '2004-%s, Richard Purdie, Chris Larson, and Phil Blundell' \
23 % datetime.datetime.now().year
24author = '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.
32extensions = [
33 'sphinx.ext.autosectionlabel',
34]
35autosectionlabel_prefix_document = True
36
37# Add any paths that contain templates here, relative to this directory.
38templates_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.
43exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
44
45# master document name. The default changed from contents to index. so better
46# set it ourselves.
47master_doc = 'index'
48
49# create substitution for project configuration variables
50rst_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#
61html_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".
66html_static_path = ['_static']