cacert-codedocs/source/conf.py

# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

import os
import sys
from datetime import datetime

import certifi
import requests
from docutils import nodes, utils
from git import repo

# 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.

sys.path.insert(0, os.path.abspath("."))

try:
    print("Checking connection to infradocs.cacert.org")
    requests.head("https://infradocs.cacert.org/")
    print("Connection to infradocs.cacert.org OK")
except requests.exceptions.SSLError as err:
    print("SSL Error. Adding CAcert certificates to Certifi store...")
    cafile = certifi.where()
    with open(
        os.path.join(os.path.dirname(__file__), "..", "cacert.pem"), "rb"
    ) as infile:
        cacertca = infile.read()
    with open(cafile, "ab") as outfile:
        outfile.write(cacertca)

# -- Project information -----------------------------------------------------

project = "CAcert code documentation"
copyright = "2018-2020 CAcert development team"
author = "CAcert development team"

# The short X.Y version
version = "0.1"
# The full version, including alpha/beta/rc tags
release = "{}-git:{} built:{}".format(
    version,
    repo.Repo("..").git.describe("--always", "--dirty"),
    datetime.utcnow().replace(microsecond=0),
)

# -- 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.intersphinx",
    "sphinx.ext.extlinks",
    "sphinx.ext.todo",
    "sphinx.ext.ifconfig",
    "sphinxcontrib.phpdomain",
    "sphinxcontrib.blockdiag",
    "sphinxcontrib.seqdiag",
    "sphinxext.cacert",
]

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

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"

# The master toctree document.
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None

# 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 = []

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


# -- 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 = "classic"

# 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 = {
    "sidebarbgcolor": "#f5f7f7",
    "sidebartextcolor": "#334d55",
    "sidebarlinkcolor": "#005fa9",
}

html_title = project + " v" + release

html_logo = os.path.join("images", "CAcert-logo-colour.svg")

html_favicon = os.path.join("images", "favicon.ico")

# 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"]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself.  Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}


# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = "CAcertcodedocumentationdoc"


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

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# 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 = [
    (
        master_doc,
        "CAcertcodedocumentation.tex",
        "CAcert code documentation",
        "CAcert development team",
        "manual",
    ),
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    (master_doc, "cacertcodedocumentation", "CAcert code documentation", [author], 1)
]


# -- 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 = [
    (
        master_doc,
        "CAcertcodedocumentation",
        "CAcert code documentation",
        author,
        "CAcertcodedocumentation",
        "One line description of project.",
        "Miscellaneous",
    ),
]


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

# Bibliographic Dublin Core info.
epub_title = project

# 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 list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]


# -- Extension configuration -------------------------------------------------

# -- Options for intersphinx extension ---------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"infradocs": ("https://infradocs.cacert.org", None)}

# -- Options for todo extension ----------------------------------------------

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

extlinks = {
    "wiki": ("https://wiki.cacert.org/%s", "Wiki "),
    "cacertgit": ("https://git.cacert.org/%s.git/", "CAcert Git repository "),
    "github": ("https://github.com/CAcertOrg/%s", "Github repository "),
}


def cacert_bug(name, rawtext, text, lineno, inliner, options={}, content=[]):
    try:
        bugnum = int(text)
        if bugnum <= 0:
            raise ValueError
    except ValueError:
        msg = inliner.reporter.error(
            "Bug number must be a number greater than or equal to 1; "
            '"%s" is invalid.' % text,
            line=lineno,
        )
        prb = inliner.problematic(rawtext, rawtext, msg)
        return [prb], [msg]
    ref = "https://bugs.cacert.org/view.php?id=%d" % bugnum
    node = nodes.reference(rawtext, "#" + utils.unescape(text), refuri=ref, **options)
    return [node], []


def setup(app):
    app.add_role("bug", cacert_bug)