X-Git-Url: https://git.ozlabs.org/?p=petitboot;a=blobdiff_plain;f=doc%2Fconf.py;fp=doc%2Fconf.py;h=2403c1dbd16bb38615e2b150372aa97ad0cb453e;hp=0000000000000000000000000000000000000000;hb=d61806e79788d996581311d2eb25bc043c37435a;hpb=cf9e0cd6f7caf7b171457f7bf9f56f23ec3e478c diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000..2403c1d --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,58 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Petitboot' +copyright = '2019, Samuel Mendoza-Jonas, IBM' +author = 'Samuel Mendoza-Jonas' + +# The full version, including alpha/beta/rc tags +release = 'v1.10.3' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Older Sphinx defaults to 'contents' +master_doc = 'index'