conf.py

# -*- coding: utf-8 -*-
#
# UBports documentation build configuration file, created by
# sphinx-quickstart on Sun Mar  5 23:09:36 2017.
#
# 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.

# 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('.'))


# -- 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.todo',
    'sphinxext.rediraffe'
]

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

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'UBports'
copyright = u'2019-2023, The UBports project (Creative Commons BY-SA 4.0)'
author = u'UBports project'

# 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 short X.Y version.
version = u''
# The full version, including alpha/beta/rc tags.
release = u''

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

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'README.md', '.local']

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

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


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

# 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 = {
    "sidebar_hide_name": True,
    "light_logo": "images/logo-light.svg",
    "dark_logo": "images/logo-dark.svg",
    "light_css_variables": {
        "font-stack": "ubuntu, sans-serif",
        "font-stack--monospace": "ubuntu-mono, Courier, monospace",
        "color-brand-primary": "#000000",
        "color-background-primary": "#F7F7F7",
        "color-sidebar-search-border": "transparent",
        "color-sidebar-search-background": "#F7F7F7",
        "color-sidebar-background": "#FFFFFF",
        "sidebar-search-icon-size": "1px",
        "color-sidebar-background-border": "transparent",
        "color-link": "var(--color-foreground-primary)",
        "color-link--hover": "var(--color-foreground-primary)",
        "color-link-underline": "var(--color-foreground-primary)",
        "color-link-underline--hover": "#E95420",
        "color-admonition-title--note": "var(--color-toc-item-text)",
        "color-admonition-title-background--note": "var(--color-sidebar-background)",
        "sidebar-caption-font-size": "1.6rem"
    },
    "dark_css_variables": {
        "color-brand-primary": "#EDEDED",
        "color-background-primary": "#141417",
        "color-sidebar-search-background": "#141417",
        "color-sidebar-background": "#1A1C1E"
    },
}

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

rediraffe_redirects = "redirects.txt"
rediraffe_branch = "master"


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

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


# -- 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, 'UBportsdocs.tex', u'UBports Documentation',
     u'Marius Gripsgard', '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, 'ubportsdocs', u'UBports 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, 'UBportsdocs', u'UBports Documentation',
     author, 'UBportsdocs', 'A beautiful mobile OS.',
     'Miscellaneous'),
]

github_doc_root = ''
def setup(app):
    app.add_css_file('css/ubports.css')