| 1 |
#!/usr/bin/env python3 |
| 2 |
# -*- coding: utf-8 -*- |
| 3 |
# |
| 4 |
# cdist-docs documentation build configuration file, created by |
| 5 |
# sphinx-quickstart on Fri May 6 21:45:28 2016. |
| 6 |
# |
| 7 |
# This file is execfile()d with the current directory set to its |
| 8 |
# containing dir. |
| 9 |
# |
| 10 |
# Note that not all possible configuration values are present in this |
| 11 |
# autogenerated file. |
| 12 |
# |
| 13 |
# All configuration values have a default; values that are commented out |
| 14 |
# serve to show the default. |
| 15 |
|
| 16 |
import sys |
| 17 |
import os |
| 18 |
import sphinx_rtd_theme |
| 19 |
|
| 20 |
# If extensions (or modules to document with autodoc) are in another directory, |
| 21 |
# add these directories to sys.path here. If the directory is relative to the |
| 22 |
# documentation root, use os.path.abspath to make it absolute, like shown here. |
| 23 |
# sys.path.insert(0, os.path.abspath('.')) |
| 24 |
sys.path.insert(0, os.path.abspath(os.path.join( |
| 25 |
os.path.dirname(os.path.realpath(__file__)), "..", ".."))) |
| 26 |
|
| 27 |
# Import cdist after sys.path fixup above. |
| 28 |
|
| 29 |
import cdist.version # nopep8 - ignore error that import is not at top |
| 30 |
|
| 31 |
# -- General configuration ------------------------------------------------ |
| 32 |
|
| 33 |
# If your documentation needs a minimal Sphinx version, state it here. |
| 34 |
# needs_sphinx = '1.0' |
| 35 |
|
| 36 |
# Add any Sphinx extension module names here, as strings. They can be |
| 37 |
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
| 38 |
# ones. |
| 39 |
extensions = [ |
| 40 |
'cdist.sphinxext.manpage', |
| 41 |
'sphinx.ext.extlinks', |
| 42 |
] |
| 43 |
|
| 44 |
# Add any paths that contain templates here, relative to this directory. |
| 45 |
templates_path = ['_templates'] |
| 46 |
|
| 47 |
# The suffix(es) of source filenames. |
| 48 |
# You can specify multiple suffix as a list of string: |
| 49 |
source_suffix = ['.rst'] |
| 50 |
|
| 51 |
# The encoding of source files. |
| 52 |
# source_encoding = 'utf-8-sig' |
| 53 |
|
| 54 |
# The master toctree document. |
| 55 |
master_doc = 'index' |
| 56 |
|
| 57 |
# General information about the project. |
| 58 |
project = 'cdist' |
| 59 |
copyright = 'ungleich GmbH 2021' |
| 60 |
# author = 'Darko Poljak' |
| 61 |
|
| 62 |
# The version info for the project you're documenting, acts as replacement for |
| 63 |
# |version| and |release|, also used in various other places throughout the |
| 64 |
# built documents. |
| 65 |
# |
| 66 |
# The short X.Y version. |
| 67 |
version = cdist.version.VERSION |
| 68 |
# The full version, including alpha/beta/rc tags. |
| 69 |
release = version |
| 70 |
|
| 71 |
# The language for content autogenerated by Sphinx. Refer to documentation |
| 72 |
# for a list of supported languages. |
| 73 |
# |
| 74 |
# This is also used if you do content translation via gettext catalogs. |
| 75 |
# Usually you set "language" from the command line for these cases. |
| 76 |
language = None |
| 77 |
|
| 78 |
# There are two options for replacing |today|: either, you set today to some |
| 79 |
# non-false value, then it is used: |
| 80 |
# today = '' |
| 81 |
# Else, today_fmt is used as the format for a strftime call. |
| 82 |
# today_fmt = '%B %d, %Y' |
| 83 |
|
| 84 |
# List of patterns, relative to source directory, that match files and |
| 85 |
# directories to ignore when looking for source files. |
| 86 |
# This patterns also effect to html_static_path and html_extra_path |
| 87 |
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
| 88 |
|
| 89 |
# The reST default role (used for this markup: `text`) to use for all |
| 90 |
# documents. |
| 91 |
# default_role = None |
| 92 |
|
| 93 |
# If true, '()' will be appended to :func: etc. cross-reference text. |
| 94 |
# add_function_parentheses = True |
| 95 |
|
| 96 |
# If true, the current module name will be prepended to all description |
| 97 |
# unit titles (such as .. function::). |
| 98 |
# add_module_names = True |
| 99 |
|
| 100 |
# If true, sectionauthor and moduleauthor directives will be shown in the |
| 101 |
# output. They are ignored by default. |
| 102 |
# show_authors = False |
| 103 |
|
| 104 |
# The name of the Pygments (syntax highlighting) style to use. |
| 105 |
pygments_style = 'sphinx' |
| 106 |
|
| 107 |
# A list of ignored prefixes for module index sorting. |
| 108 |
# modindex_common_prefix = [] |
| 109 |
|
| 110 |
# If true, keep warnings as "system message" paragraphs in the built documents. |
| 111 |
# keep_warnings = False |
| 112 |
|
| 113 |
# If true, `todo` and `todoList` produce output, else they produce nothing. |
| 114 |
todo_include_todos = False |
| 115 |
|
| 116 |
|
| 117 |
# -- Options for HTML output ---------------------------------------------- |
| 118 |
|
| 119 |
# The theme to use for HTML and HTML Help pages. See the documentation for |
| 120 |
# a list of builtin themes. |
| 121 |
html_theme = 'sphinx_rtd_theme' |
| 122 |
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] |
| 123 |
|
| 124 |
# Theme options are theme-specific and customize the look and feel of a theme |
| 125 |
# further. For a list of options available for each theme, see the |
| 126 |
# documentation. |
| 127 |
# html_theme_options = {} |
| 128 |
|
| 129 |
# Add any paths that contain custom themes here, relative to this directory. |
| 130 |
# html_theme_path = [] |
| 131 |
|
| 132 |
# The name for this set of Sphinx documents. |
| 133 |
# "<project> v<release> documentation" by default. |
| 134 |
# html_title = 'cdist-docs v0.0.1' |
| 135 |
|
| 136 |
# A shorter title for the navigation bar. Default is the same as html_title. |
| 137 |
# html_short_title = None |
| 138 |
|
| 139 |
# The name of an image file (relative to this directory) to place at the top |
| 140 |
# of the sidebar. |
| 141 |
html_logo = '_static/cdist-logo.jpeg' |
| 142 |
|
| 143 |
# The name of an image file (relative to this directory) to use as a favicon of |
| 144 |
# the docs. This file should be a Windows icon file (.ico) |
| 145 |
# being 16x16 or 32x32 |
| 146 |
# pixels large. |
| 147 |
# html_favicon = None |
| 148 |
|
| 149 |
# Add any paths that contain custom static files (such as style sheets) here, |
| 150 |
# relative to this directory. They are copied after the builtin static files, |
| 151 |
# so a file named "default.css" will overwrite the builtin "default.css". |
| 152 |
# html_static_path = ['_static'] |
| 153 |
html_static_path = ['_static'] |
| 154 |
|
| 155 |
# Add any extra paths that contain custom files (such as robots.txt or |
| 156 |
# .htaccess) here, relative to this directory. These files are copied |
| 157 |
# directly to the root of the documentation. |
| 158 |
# html_extra_path = [] |
| 159 |
|
| 160 |
# If not None, a 'Last updated on:' timestamp is inserted at every page |
| 161 |
# bottom, using the given strftime format. |
| 162 |
# The empty string is equivalent to '%b %d, %Y'. |
| 163 |
# html_last_updated_fmt = None |
| 164 |
|
| 165 |
# Custom sidebar templates, maps document names to template names. |
| 166 |
# html_sidebars = {} |
| 167 |
|
| 168 |
# Additional templates that should be rendered to pages, maps page names to |
| 169 |
# template names. |
| 170 |
# html_additional_pages = {} |
| 171 |
|
| 172 |
# If false, no module index is generated. |
| 173 |
# html_domain_indices = True |
| 174 |
|
| 175 |
# If false, no index is generated. |
| 176 |
# html_use_index = True |
| 177 |
|
| 178 |
# If true, the index is split into individual pages for each letter. |
| 179 |
# html_split_index = False |
| 180 |
|
| 181 |
# If true, links to the reST sources are added to the pages. |
| 182 |
# html_show_sourcelink = True |
| 183 |
|
| 184 |
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
| 185 |
# html_show_sphinx = True |
| 186 |
|
| 187 |
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
| 188 |
# html_show_copyright = True |
| 189 |
|
| 190 |
# If true, an OpenSearch description file will be output, and all pages will |
| 191 |
# contain a <link> tag referring to it. The value of this option must be the |
| 192 |
# base URL from which the finished HTML is served. |
| 193 |
# html_use_opensearch = '' |
| 194 |
|
| 195 |
# This is the file name suffix for HTML files (e.g. ".xhtml"). |
| 196 |
# html_file_suffix = None |
| 197 |
# html_file_suffix = "" |
| 198 |
|
| 199 |
# Language to be used for generating the HTML full-text search index. |
| 200 |
# Sphinx supports the following languages: |
| 201 |
# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' |
| 202 |
# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' |
| 203 |
# html_search_language = 'en' |
| 204 |
|
| 205 |
# A dictionary with options for the search language support, empty by default. |
| 206 |
# 'ja' uses this config value. |
| 207 |
# 'zh' user can custom change `jieba` dictionary path. |
| 208 |
# html_search_options = {'type': 'default'} |
| 209 |
|
| 210 |
# The name of a javascript file (relative to the configuration directory) that |
| 211 |
# implements a search results scorer. If empty, the default will be used. |
| 212 |
# html_search_scorer = 'scorer.js' |
| 213 |
|
| 214 |
# Output file base name for HTML help builder. |
| 215 |
htmlhelp_basename = 'cdistdoc' |
| 216 |
|
| 217 |
# -- Options for LaTeX output --------------------------------------------- |
| 218 |
|
| 219 |
# latex_elements = { |
| 220 |
# The paper size ('letterpaper' or 'a4paper'). |
| 221 |
# 'papersize': 'letterpaper', |
| 222 |
|
| 223 |
# The font size ('10pt', '11pt' or '12pt'). |
| 224 |
# 'pointsize': '10pt', |
| 225 |
|
| 226 |
# Additional stuff for the LaTeX preamble. |
| 227 |
# 'preamble': '', |
| 228 |
|
| 229 |
# Latex figure (float) alignment |
| 230 |
# 'figure_align': 'htbp', |
| 231 |
# } |
| 232 |
|
| 233 |
# Grouping the document tree into LaTeX files. List of tuples |
| 234 |
# (source start file, target name, title, |
| 235 |
# author, documentclass [howto, manual, or own class]). |
| 236 |
latex_documents = [ |
| 237 |
(master_doc, 'cdist.tex', 'cdist Documentation', |
| 238 |
'Darko Poljak', 'manual'), |
| 239 |
] |
| 240 |
|
| 241 |
# The name of an image file (relative to this directory) to place at the top of |
| 242 |
# the title page. |
| 243 |
# latex_logo = None |
| 244 |
|
| 245 |
# For "manual" documents, if this is true, then toplevel headings are parts, |
| 246 |
# not chapters. |
| 247 |
# latex_use_parts = False |
| 248 |
|
| 249 |
# If true, show page references after internal links. |
| 250 |
# latex_show_pagerefs = False |
| 251 |
|
| 252 |
# If true, show URL addresses after external links. |
| 253 |
# latex_show_urls = False |
| 254 |
|
| 255 |
# Documents to append as an appendix to all manuals. |
| 256 |
# latex_appendices = [] |
| 257 |
|
| 258 |
# If false, no module index is generated. |
| 259 |
# latex_domain_indices = True |
| 260 |
|
| 261 |
|
| 262 |
# -- Options for manual page output --------------------------------------- |
| 263 |
|
| 264 |
# One entry per manual page. List of tuples |
| 265 |
# (source start file, name, description, authors, manual section). |
| 266 |
root_mandir = os.path.dirname(os.path.realpath(__file__)) |
| 267 |
mandirs = [] |
| 268 |
for mansubdir in ('man1', 'man7'): |
| 269 |
mandirs.append((os.path.join(root_mandir, mansubdir), mansubdir[-1])) |
| 270 |
man_pages = [] |
| 271 |
for mandir, section in mandirs: |
| 272 |
for root, dirs, files in os.walk(mandir): |
| 273 |
for fname in files: |
| 274 |
froot, fext = os.path.splitext(fname) |
| 275 |
if fext == '.rst': |
| 276 |
man_page = (os.path.join('man' + str(section), froot), |
| 277 |
froot, '', [], section) |
| 278 |
man_pages.append(man_page) |
| 279 |
|
| 280 |
# man_pages = [ |
| 281 |
# ('cdist-type', 'cdist-type', 'cdist-type documentation', |
| 282 |
# [author], 1), |
| 283 |
# ('man7/cdist-type__file', 'cdist-type__file', |
| 284 |
# '', [], 1), |
| 285 |
# ('cdist-type__directory', 'cdist-type__directory', |
| 286 |
# 'cdist-type__directory documentation', [author], 1), |
| 287 |
# ] |
| 288 |
|
| 289 |
# If true, show URL addresses after external links. |
| 290 |
# man_show_urls = False |
| 291 |
|
| 292 |
|
| 293 |
# -- Options for Texinfo output ------------------------------------------- |
| 294 |
|
| 295 |
# Grouping the document tree into Texinfo files. List of tuples |
| 296 |
# (source start file, target name, title, author, |
| 297 |
# dir menu entry, description, category) |
| 298 |
texinfo_documents = [ |
| 299 |
(master_doc, 'cdist', 'cdist Documentation', |
| 300 |
'', 'cdist', 'Configuration management system.', |
| 301 |
'Miscellaneous'), |
| 302 |
] |
| 303 |
|
| 304 |
# Documents to append as an appendix to all manuals. |
| 305 |
# texinfo_appendices = [] |
| 306 |
|
| 307 |
# If false, no module index is generated. |
| 308 |
# texinfo_domain_indices = True |
| 309 |
|
| 310 |
# How to display URL addresses: 'footnote', 'no', or 'inline'. |
| 311 |
# texinfo_show_urls = 'footnote' |
| 312 |
|
| 313 |
# If true, do not generate a @detailmenu in the "Top" node's menu. |
| 314 |
# texinfo_no_detailmenu = False |