jan/debianmemberportfolio
1
0
Fork 1
Code Issues Pull requests Releases Wiki Activity

Add master_doc setting for readthedocs

Browse source
This commit is contained in:
Jan Dittberner 2021-07-03 12:18:06 +02:00
parent b66e80a299
commit 108da9dec2
1 changed files with 29 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

37
docs/source/conf.py
View file

@ -22,41 +22,40 @@ import os
# If your extensions are in another directory, add it here. If the directory # 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 # is relative to the documentation root, use os.path.abspath to make it
# absolute, like shown here. # absolute, like shown here.
sys.path.append( sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "..")))
os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..')))
# General configuration # General configuration
# --------------------- # ---------------------
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ["_templates"]
# The encoding of source files. # The encoding of source files.
# source_encoding = 'utf-8' # source_encoding = 'utf-8'
# General information about the project. # General information about the project.
project = 'Debian Member Portfolio Service' project = "Debian Member Portfolio Service"
copyright = '2009-2021, Jan Dittberner' copyright = "2009-2021, Jan Dittberner"
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.7.0' version = "0.7.0"
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = version release = version
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
language = 'en' language = "en"
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = "sphinx"
# ----------------------- # -----------------------
@ -64,17 +63,17 @@ pygments_style = 'sphinx'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ["_static"]
# If false, no module index is generated. # If false, no module index is generated.
html_use_modindex = False html_use_modindex = False
# If false, no index is generated. # If false, no index is generated.
# html_use_index = True # html_use_index = True
html_theme = 'alabaster' html_theme = "alabaster"
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'DebianMemberPortfolioServicedoc' htmlhelp_basename = "DebianMemberPortfolioServicedoc"
# Options for LaTeX output # Options for LaTeX output
# ------------------------ # ------------------------
@ -89,11 +88,13 @@ htmlhelp_basename = 'DebianMemberPortfolioServicedoc'
# (source start file, target name, title, author, document class # (source start file, target name, title, author, document class
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', (
'DebianMemberPortfolioService.tex', "index",
'Debian Member Portfolio Service Documentation', "DebianMemberPortfolioService.tex",
'Jan Dittberner', "Debian Member Portfolio Service Documentation",
'manual'), "Jan Dittberner",
"manual",
),
] ]
# The name of an image file (relative to this directory) to place at the top of # The name of an image file (relative to this directory) to place at the top of
@ -112,3 +113,5 @@ latex_documents = [
# If false, no module index is generated. # If false, no module index is generated.
# latex_use_modindex = True # latex_use_modindex = True
master_doc = "index"