Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
# -*- coding: utf-8 -*-
# This is the configuration file for the Sphinx documentation builder.
# It was created by the Go Forward Sphinx documentation framework.
#
# See https://github.com/PeterMosmans/setup-sphinx-framework for more information
import os
import sys
LATEX_STYLING = "_static/latex-styling.tex"
# Set some defaults in case projectsettings doesn't exist
# Note that these can be / should be overridden in projectsettings.py
version = "0.1.0"
author = "Peter Mosmans"
company = "Go Forward"
copyright = f"2020, {company} / {author}"
customer = "Go Forward"
filename = "Documentation"
project_type = "Documentation"
project = f"{project_type} for {customer}"
target = "https://www.go-forward.net"
documentation_site = target
description = project
try:
sys.path.append(os.path.dirname(__file__))
from local_settings import *
except ImportError as exception:
print(
f"Did not import specific settings from projectsettings: {exception}",
file=sys.stderr,
)
try:
with open(LATEX_STYLING, mode="r+") as latex_styling:
PREAMBLE = latex_styling.read()
except FileNotFoundError:
print(
"Did not import PDF-specific settings from {LATEX_STYLING}: {exception}",
file=sys.stderr,
)
PREAMBLE = ""
release = version
# 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
# Parameterize project-specific variables
rst_prolog = f"""
.. |company| replace:: {company}
.. |customer| replace:: {customer}
.. |documentation_site| replace:: {documentation_site}
.. |project_type| replace:: {project_type}
.. |project| replace:: {project}
.. |target| replace:: {target}
"""
# -- General configuration ---------------------------------------------------
# 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.autosectionlabel"]
# Add a unique prefix per document
autosectionlabel_prefix_document = True
# 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"
# Don't copy source files
html_copy_source = False
# Don't show footer
html_show_sphinx = False
# 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 = "monokai"
# -- 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 = "sphinx_rtd_theme"
html_theme_options = {"display_version": True}
# 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 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 = filename
# -- Options for LaTeX output ------------------------------------------------
# oneside: left and right margins are symmetric
# openany: start chapter on any page (even or odd)
latex_elements = {
"extraclassoptions": "openany,oneside",
"papersize": "a4paper",
"pointsize": "10pt",
"preamble": PREAMBLE,
}
latex_engine = "xelatex"
# 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, filename + ".tex", project, 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 = [(master_doc, filename, project, 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,
filename,
project,
author,
filename + ".tex",
description,
"Miscellaneous",
)
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# 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"]