From 5e213917b797081e018c12ad628c5aa9e96f9e89 Mon Sep 17 00:00:00 2001 From: Jan Dittberner Date: Tue, 27 Oct 2020 08:28:27 +0100 Subject: [PATCH] Fix documentation build --- docs/source/conf.py | 101 ++++---------------------------------------- 1 file changed, 8 insertions(+), 93 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d734bf7..d715c3e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,27 +33,21 @@ sys.path.append( extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. -templates_path = ['.templates'] - -# The suffix of source filenames. -source_suffix = '.rst' +templates_path = ['_templates'] # The encoding of source files. #source_encoding = 'utf-8' -# The master toctree document. -master_doc = 'index' - # General information about the project. -project = u'Debian Member Portfolio Service' -copyright = u'2009-2019, Jan Dittberner' +project = 'Debian Member Portfolio Service' +copyright = '2009-2020, 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.6.3' +version = '0.6.4' # The full version, including alpha/beta/rc tags. release = version @@ -61,106 +55,27 @@ release = version # for a list of supported languages. language = 'en' -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' -# Options for HTML output # ----------------------- -# The style sheet to use for HTML and HTML Help pages. A file of that name -# must exist either in Sphinx' static/ path, or in one of the custom paths -# given in html_static_path. -html_style = 'default.css' - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - # 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} +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 - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, the reST sources are included in the HTML build as _sources/. -#html_copy_source = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +html_theme = 'alabaster' # Output file base name for HTML help builder. htmlhelp_basename = 'DebianMemberPortfolioServicedoc' - # Options for LaTeX output # ------------------------ @@ -176,8 +91,8 @@ htmlhelp_basename = 'DebianMemberPortfolioServicedoc' latex_documents = [ ('index', 'DebianMemberPortfolioService.tex', - ur'Debian Member Portfolio Service Documentation', - ur'Jan Dittberner', + 'Debian Member Portfolio Service Documentation', + 'Jan Dittberner', 'manual'), ]