From ec7552c260596cab5230cc07c790f3f24decb9a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Schl=C3=B6sser?= Date: Thu, 17 Aug 2023 08:43:34 +0200 Subject: [PATCH] Prepare version 0.7.0 --- doc/conf.py | 58 ++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index cc0d1f1..fc435a5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -14,19 +14,20 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../fhem/fhem')) + +sys.path.insert(0, os.path.abspath("../fhem/fhem")) # -- Project information ----------------------------------------------------- -project = 'fhem' -copyright = '2018-2019, Dominik Schlösser and contributors' -author = 'Dominik Schlösser' +project = "fhem" +copyright = "2018-2023, Dominik Schlösser and contributors" +author = "Dominik Schlösser" # The short X.Y version -version = '' +version = "0.7" # The full version, including alpha/beta/rc tags -release = '0.6.5' +release = "0.7.0" # -- General configuration --------------------------------------------------- @@ -39,22 +40,22 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.githubpages', + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "sphinx.ext.githubpages", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +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' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -66,10 +67,10 @@ # 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 = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # -- Options for HTML output ------------------------------------------------- @@ -77,7 +78,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +html_theme = "alabaster" # 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 @@ -88,7 +89,7 @@ # 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"] # Custom sidebar templates, must be a dictionary that maps document names # to template names. @@ -104,7 +105,7 @@ # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'fhemdoc' +htmlhelp_basename = "fhemdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -113,15 +114,12 @@ # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. # # 'preamble': '', - # Latex figure (float) alignment # # 'figure_align': 'htbp', @@ -131,8 +129,7 @@ # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'fhem.tex', 'fhem Documentation', - 'Dominik Schlösser', 'manual'), + (master_doc, "fhem.tex", "fhem Documentation", "Dominik Schlösser", "manual"), ] @@ -140,10 +137,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'fhem', 'fhem Documentation', - [author], 1) -] +man_pages = [(master_doc, "fhem", "fhem Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -152,9 +146,15 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'fhem', 'fhem Documentation', - author, 'fhem', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "fhem", + "fhem Documentation", + author, + "fhem", + "One line description of project.", + "Miscellaneous", + ), ]