debianmemberportfolio/docs/source/conf.py

118 lines
3.4 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
# Debian Member Portfolio Service documentation build configuration file,
# created by sphinx-quickstart on Tue Jan 20 22:27:21 2009.
#
# This file is execfile()d with the current directory set to its containing
# dir.
#
# The contents of this file are pickled, so don't put values in the namespace
# that aren't pickleable (module imports are okay, they're removed
# automatically).
#
# 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
# If your extensions are in another directory, add it here. If the directory
# is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here.
2021-07-03 12:18:06 +02:00
sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..")))
# 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.
2021-07-03 12:18:06 +02:00
extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
# Add any paths that contain templates here, relative to this directory.
2021-07-03 12:18:06 +02:00
templates_path = ["_templates"]
# The encoding of source files.
2021-07-03 12:18:06 +02:00
# source_encoding = 'utf-8'
# General information about the project.
2021-07-03 12:18:06 +02:00
project = "Debian Member Portfolio Service"
copyright = "2009-2023, Jan Dittberner"
# 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.
2023-06-03 18:28:36 +02:00
version = "0.8.0"
# The full version, including alpha/beta/rc tags.
release = version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
2021-07-03 12:18:06 +02:00
language = "en"
# The name of the Pygments (syntax highlighting) style to use.
2021-07-03 12:18:06 +02:00
pygments_style = "sphinx"
# -----------------------
# 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".
2021-07-03 12:18:06 +02:00
html_static_path = ["_static"]
# If false, no module index is generated.
html_use_modindex = False
# If false, no index is generated.
2021-07-03 12:18:06 +02:00
# html_use_index = True
html_theme = "alabaster"
# Output file base name for HTML help builder.
2021-07-03 12:18:06 +02:00
htmlhelp_basename = "DebianMemberPortfolioServicedoc"
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
2021-07-03 12:18:06 +02:00
# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
2021-07-03 12:18:06 +02:00
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class
# [howto/manual]).
2023-06-03 18:28:36 +02:00
# latex_documents = [
# (
# "index",
# "DebianMemberPortfolioService.tex",
# "Debian Member Portfolio Service Documentation",
# "Jan Dittberner",
# "manual",
# ),
2023-06-03 18:28:36 +02:00
# ]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
2021-07-03 12:18:06 +02:00
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
2021-07-03 12:18:06 +02:00
# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
2021-07-03 12:18:06 +02:00
# latex_preamble = ''
# Documents to append as an appendix to all manuals.
2021-07-03 12:18:06 +02:00
# latex_appendices = []
# If false, no module index is generated.
2021-07-03 12:18:06 +02:00
# latex_use_modindex = True
master_doc = "index"