diff options
author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-05-26 19:14:48 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-17 10:09:32 +0100 |
commit | c40a8d5904c29046f1cbbeb998e6cd7c24f9b206 (patch) | |
tree | 87ad0d939b57fbd9c0c0369979189ed2fdcc58a7 /documentation/conf.py | |
parent | a32ddf91bc23cd6c3976f569335ae591e2c86c4d (diff) | |
download | poky-c40a8d5904c29046f1cbbeb998e6cd7c24f9b206.tar.gz |
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.
(From yocto-docs rev: 01dd5af7954e24552aca022917669b27bb0541ed)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/conf.py')
-rw-r--r-- | documentation/conf.py | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/documentation/conf.py b/documentation/conf.py new file mode 100644 index 0000000000..2afaf81810 --- /dev/null +++ b/documentation/conf.py | |||
@@ -0,0 +1,55 @@ | |||
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 | |||
18 | # -- Project information ----------------------------------------------------- | ||
19 | |||
20 | project = 'The Yocto Project' | ||
21 | copyright = '2020, The Linux Foundation' | ||
22 | author = 'The Linux Foundation' | ||
23 | |||
24 | |||
25 | # -- General configuration --------------------------------------------------- | ||
26 | |||
27 | # Add any Sphinx extension module names here, as strings. They can be | ||
28 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
29 | # ones. | ||
30 | extensions = [ | ||
31 | ] | ||
32 | |||
33 | # Add any paths that contain templates here, relative to this directory. | ||
34 | templates_path = ['_templates'] | ||
35 | |||
36 | # List of patterns, relative to source directory, that match files and | ||
37 | # directories to ignore when looking for source files. | ||
38 | # This pattern also affects html_static_path and html_extra_path. | ||
39 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
40 | |||
41 | # master document name. The default changed from contents to index. so better | ||
42 | # set it ourselves. | ||
43 | master_doc = 'index' | ||
44 | |||
45 | # -- Options for HTML output ------------------------------------------------- | ||
46 | |||
47 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
48 | # a list of builtin themes. | ||
49 | # | ||
50 | html_theme = 'alabaster' | ||
51 | |||
52 | # Add any paths that contain custom static files (such as style sheets) here, | ||
53 | # relative to this directory. They are copied after the builtin static files, | ||
54 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
55 | html_static_path = ['_static'] | ||