|
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
|
|
|
import sphinx_rtd_theme |
|
17
|
|
|
|
|
18
|
|
|
# -- Project information ----------------------------------------------------- |
|
19
|
|
|
|
|
20
|
|
|
project = 'OpenSCAP Report Generator' |
|
21
|
|
|
copyright = 'OpenSCAP' |
|
22
|
|
|
author = 'OpenSCAP' |
|
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
|
|
|
'sphinx_rtd_theme', |
|
32
|
|
|
'sphinxarg.ext', |
|
33
|
|
|
'sphinx.ext.autodoc', |
|
34
|
|
|
] |
|
35
|
|
|
|
|
36
|
|
|
# Prefix document path to section labels, otherwise autogenerated labels would look like 'heading' |
|
37
|
|
|
# rather than 'path/to/file:heading' |
|
38
|
|
|
autosectionlabel_prefix_document = True |
|
39
|
|
|
|
|
40
|
|
|
# Add any paths that contain templates here, relative to this directory. |
|
41
|
|
|
# templates_path = ['_templates'] |
|
42
|
|
|
|
|
43
|
|
|
# List of patterns, relative to source directory, that match files and |
|
44
|
|
|
# directories to ignore when looking for source files. |
|
45
|
|
|
# This pattern also affects html_static_path and html_extra_path. |
|
46
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
|
47
|
|
|
|
|
48
|
|
|
|
|
49
|
|
|
# -- Options for HTML output ------------------------------------------------- |
|
50
|
|
|
|
|
51
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
|
52
|
|
|
# a list of builtin themes. |
|
53
|
|
|
# |
|
54
|
|
|
html_theme = 'sphinx_rtd_theme' |
|
55
|
|
|
|
|
56
|
|
|
man_pages = [('oscap-report.8', 'oscap-report', '', '', 8)] |
|
57
|
|
|
|
|
58
|
|
|
|
|
59
|
|
|
# Add any paths that contain custom static files (such as style sheets) here, |
|
60
|
|
|
# relative to this directory. They are copied after the builtin static files, |
|
61
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css". |
|
62
|
|
|
# html_static_path = ['_static'] |
|
63
|
|
|
source_suffix = ['.rst', '.md'] |