From 108da9dec2acb8b2df22af15e7c8678c958256d4 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Sat, 3 Jul 2021 12:18:06 +0200 Subject: [PATCH] Add master_doc setting for readthedocs --- docs/source/conf.py | 55 ++++++++++++++++++++++++--------------------- 1 file changed, 29 insertions(+), 26 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index f29c685..cdbe07a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -22,41 +22,40 @@ 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. -sys.path.append( - os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))) +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. -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. -templates_path = ['_templates'] +templates_path = ["_templates"] # The encoding of source files. -#source_encoding = 'utf-8' +# source_encoding = 'utf-8' # General information about the project. -project = 'Debian Member Portfolio Service' -copyright = '2009-2021, Jan Dittberner' +project = "Debian Member Portfolio Service" +copyright = "2009-2021, 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. -version = '0.7.0' +version = "0.7.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. -language = 'en' +language = "en" # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # ----------------------- @@ -64,51 +63,55 @@ 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". -html_static_path = ['_static'] +html_static_path = ["_static"] # If false, no module index is generated. html_use_modindex = False # If false, no index is generated. -#html_use_index = True -html_theme = 'alabaster' +# html_use_index = True +html_theme = "alabaster" # Output file base name for HTML help builder. -htmlhelp_basename = 'DebianMemberPortfolioServicedoc' +htmlhelp_basename = "DebianMemberPortfolioServicedoc" # Options for LaTeX output # ------------------------ # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# 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]). latex_documents = [ - ('index', - 'DebianMemberPortfolioService.tex', - 'Debian Member Portfolio Service Documentation', - 'Jan Dittberner', - 'manual'), + ( + "index", + "DebianMemberPortfolioService.tex", + "Debian Member Portfolio Service Documentation", + "Jan Dittberner", + "manual", + ), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_use_modindex = True +# latex_use_modindex = True + +master_doc = "index"