conf.py 12.9 KB
Newer Older
1 2 3
# -*- coding: utf-8 -*-
#
# DebOps documentation build configuration file
4
# Copyright (C) 2014-2018 DebOps Project https://debops.org/
5 6 7 8 9 10 11 12 13 14 15 16 17
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

18 19 20
import sphinx.environment
from docutils.utils import get_source_line

21 22 23
# 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.
24 25 26
sys.path.insert(0, os.path.abspath('_lib'))

import yaml2rst  # noqa
27
import edit_url  # noqa
28 29 30 31 32 33 34 35 36 37 38 39 40 41

rst_ansible_roles = 'ansible/roles/'
yml_ansible_roles = '../ansible/roles/'

# Convert Ansible role defaults files written in YAML to documentation written
# in reStructuredText
for element in os.listdir(rst_ansible_roles):
    if os.path.isdir(yml_ansible_roles + element + '/defaults'):
        yaml2rst.convert_file(
            yml_ansible_roles + element + '/defaults/main.yml',
            rst_ansible_roles + element + '/defaults.rst',
            strip_regex=r'\s*(:?\[{3}|\]{3})\d?$',
            yaml_strip_regex=r'^\s{66,67}#\s\]{3}\d?$',
        )
42

43 44 45 46 47 48 49 50 51

# Ignore warnings about non-local images
def _warn_node(self, msg, node, **kwargs):
    if not msg.startswith('nonlocal image URI found:'):
        self._warnfunc(msg, '%s:%s' % get_source_line(node))


sphinx.environment.BuildEnvironment.warn_node = _warn_node

52 53 54 55 56 57 58 59 60 61 62 63
git_commit_id = os.popen('git rev-parse --short HEAD').read().strip()

html_context = {
    'display_github': True,  # # Add 'Edit on Github' link
    'github_user': 'debops',
    'github_repo': 'debops',
    'github_version': 'master',
    'conf_py_path': '/docs/',
    'commit': git_commit_id,
    'source_file_to_url_map': edit_url.get_source_file_to_url_map(
        start_dir=os.path.dirname(__file__),
        skip_patterns=[]
64
    )
65 66
}

67 68 69 70 71 72 73 74 75

# Add custom .css and .js files from '_static/' directory in a way compatible
# with ReadTheDocs.org deployment
# Source: https://github.com/rtfd/sphinx_rtd_theme/issues/117
def setup(app):
    # app.add_javascript("custom.js")
    app.add_stylesheet("theme_overrides.css")


76 77 78 79 80 81 82 83 84 85
# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'sphinx.ext.ifconfig',
86 87
    'sphinx.ext.graphviz',
    'autolink'
88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'DebOps'
author = u'Maciej Delmanowski, Nick Janetakis, Robin Schneider'
105
copyright = u'2014-2018, {}'.format(author)
106 107 108 109 110 111

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The full version, including alpha/beta/rc tags.
112 113 114
release = os.popen('git describe').read().strip()
# The short X.Y version.
version = release
115 116 117 118 119 120 121 122 123 124 125 126 127

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
128
exclude_patterns = ['_build', 'includes']
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179

# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# The default language to highlight source code in. The default is 'python'.
# The value should be a valid Pygments lexer name, see Showing code examples
# for more details.
highlight_language = 'YAML'

# TODO: Change later to this when it can handle:
# enabled: '{{ True
#              if (owncloud_database_name != owncloud_database_user)
#              else False }}'
#  highlight_language = 'YAML+Jinja'

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False


# -- 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 = 'default'

# Check if build is performed on ReadTheDocs.org infrastructure
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:  # only import and set the theme if we're building docs locally
    try:
        import sphinx_rtd_theme
        html_theme = 'sphinx_rtd_theme'
        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
180
        html_theme_options = {
181
            'collapse_navigation': True,
182
            'logo_only': False
183
        }
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
    except Exception:
        pass

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
# html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
204
html_logo = '_static/images/debops-small.png'
205 206 207 208

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
209
html_favicon = '_static/favicon.ico'
210 211 212 213

# 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".
214
html_static_path = ['_static']
215 216 217 218 219 220 221 222 223 224 225 226

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
227
# html_use_smartypants = False
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# If false, no module index is generated.
# html_domain_indices = True

# If false, no index is generated.
# html_use_index = True

# If true, the index is split into individual pages for each letter.
# html_split_index = False

# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'DebOpsdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
270
    'papersize': 'a4paper',
271 272

    # The font size ('10pt', '11pt' or '12pt').
273
    'pointsize': '11pt',
274 275

    # Additional stuff for the LaTeX preamble.
276 277 278 279 280
    'preamble': r'''
        \usepackage{charter}
        \usepackage[defaultsans]{lato}
        \usepackage{inconsolata}
    ''',
281 282 283 284 285 286 287 288 289 290 291 292
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = [
  ('index', 'DebOps.tex', u'DebOps Documentation',
   u'DebOps Developers', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
293
latex_logo = '_static/images/debops-small.png'
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False

# If true, show page references after internal links.
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'debops', u'DebOps Documentation',
     [author], 1)
]

# If true, show URL addresses after external links.
# man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
  ('index', 'DebOps', u'DebOps Documentation',
   author, 'DebOps', 'Your Debian-based data center in a box',
   'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
# texinfo_appendices = []

# If false, no module index is generated.
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False


# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = u'DebOps'
epub_author = author
epub_publisher = author
355
epub_copyright = u'2014-2018, Maciej Delmanowski'
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416

# The basename for the epub file. It defaults to the project name.
# epub_basename = u'DebOps'

# The HTML theme for the epub output. Since the default themes are not
# optimized for small screen space, using the same theme for HTML and epub
# output is usually not wise. This defaults to 'epub', a theme designed to save
# visual space.
# epub_theme = 'epub'

# The language of the text. It defaults to the language option
# or en if the language is not set.
# epub_language = ''

# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ''

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
# epub_identifier = ''

# A unique identification for the text.
# epub_uid = ''

# A tuple containing the cover image and cover page html template filenames.
# epub_cover = ()

# A sequence of (type, uri, title) tuples for the guide element of content.opf.
# epub_guide = ()

# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_pre_files = []

# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_post_files = []

# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']

# The depth of the table of contents in toc.ncx.
# epub_tocdepth = 3

# Allow duplicate toc entries.
# epub_tocdup = True

# Choose between 'default' and 'includehidden'.
# epub_tocscope = 'default'

# Fix unsupported image types using the PIL.
# epub_fix_images = False

# Scale large images.
# epub_max_image_width = 0

# How to display URL addresses: 'footnote', 'no', or 'inline'.
# epub_show_urls = 'inline'

# If false, no index is generated.
# epub_use_index = True