doc: Start writing some in-tree documentation
[petitboot] / doc / conf.py
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 # http://www.sphinx-doc.org/en/master/config
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 = 'Petitboot'
21 copyright = '2019, Samuel Mendoza-Jonas, IBM'
22 author = 'Samuel Mendoza-Jonas'
23
24 # The full version, including alpha/beta/rc tags
25 release = 'v1.10.3'
26
27
28 # -- General configuration ---------------------------------------------------
29
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 # ones.
33 extensions = [
34 ]
35
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38
39 # List of patterns, relative to source directory, that match files and
40 # directories to ignore when looking for source files.
41 # This pattern also affects html_static_path and html_extra_path.
42 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
43
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']
56
57 # Older Sphinx defaults to 'contents'
58 master_doc = 'index'