conf.py

# -*- coding: utf-8 -*-
"""Configuration of Sphinx documentation generator.

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

# 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 = 'octomachinery bot tutorial'  # pylint: disable=invalid-name
original_author = 'Mariatta Wijaya'  # pylint: disable=invalid-name
author = 'Sviatoslav Sydorenko'  # pylint: disable=invalid-name
# pylint: disable=invalid-name,redefined-builtin
copyright = f'2018–2020 {author}, original: ©2018 {original_author}'

# The full version, including alpha/beta/rc tags
release = '1.0'  # pylint: disable=invalid-name
# The short X.Y version
version = release  # pylint: disable=invalid-name

octomachinery_version = '0.2.1'  # pylint: disable=invalid-name

rst_epilog = f"""
.. |octomachinery_version| replace:: {octomachinery_version}
"""


# -- 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 = [  # pylint: disable=invalid-name
    'sphinx.ext.githubpages',
    'sphinx.ext.intersphinx',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']  # pylint: disable=invalid-name

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

# The master toctree document.
master_doc = 'index'  # pylint: disable=invalid-name

# 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  # pylint: disable=invalid-name

# 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 .
# pylint: disable=invalid-name
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'  # pylint: disable=invalid-name


# -- 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'  # pylint: disable=invalid-name

# 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 = {  # pylint: disable=invalid-name
    'github_user': 'sanitizers',
    'github_repo': 'github-bot-tutorial',
    'github_type': 'star',
    'github_banner': True,
    'description': 'a.k.a an introduction to octomachinery',
    'show_relbars': True,
    'extra_nav_links': {
        '🤖 octomachinery [docs]': 'https://docs.octomachinery.dev',
        '🤖 octomachinery [www]': 'https://octomachinery.dev',
    },
}

# 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']  # pylint: disable=invalid-name

# 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 = {  # pylint: disable=invalid-name
    '**': [
        'about.html',
        'sidebarlogo.html',
        'localtoc.html',
        'navigation.html',
        'relations.html',
        'searchbox.html',
    ],
}


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

# Output file base name for HTML help builder.
htmlhelp_basename = f'{project}doc'  # pylint: disable=invalid-name


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

latex_elements = {  # pylint: disable=invalid-name
    # 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 = [  # pylint: disable=invalid-name
    (
        master_doc, '{project}.tex', '{project} Documentation',
        author, 'manual',
    ),
]


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

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [  # pylint: disable=invalid-name
    (
        master_doc, project, '{project} 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 = [  # pylint: disable=invalid-name
    (
        master_doc, project, '{project} Documentation',
        author, project, 'One line description of project.',
        'Miscellaneous',
    ),
]


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

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

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
    'aiohttp': ('https://docs.aiohttp.org/en/latest/', None),
    'gidgethub': ('https://gidgethub.readthedocs.io/en/latest/', None),
    'octomachinery': ('https://docs.octomachinery.dev/en/latest/', None),
    'python': ('https://docs.python.org/', None),
}