Skip to content

Commit

Permalink
misc: Reformated docs/conf.py and check it with flake8/Black
Browse files Browse the repository at this point in the history
  • Loading branch information
flozz committed Mar 7, 2024
1 parent a096fd4 commit 831c00a
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 36 deletions.
76 changes: 40 additions & 36 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,35 +30,37 @@
# 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.doctest',
'sphinx.ext.githubpages']
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"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"

# General information about the project.
project = u'PyPAPI'
copyright = u'2017, Fabien LOISON, Mathilde BOUTIGNY'
author = u'Fabien LOISON, Mathilde BOUTIGNY'
project = "PyPAPI"
copyright = "2017, Fabien LOISON, Mathilde BOUTIGNY"
author = "Fabien LOISON, Mathilde BOUTIGNY"

# 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 = u'6.0.0'
version = "6.0.0"
# The full version, including alpha/beta/rc tags.
release = u'6.0.0.1'
release = "6.0.0.1"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -73,7 +75,7 @@
exclude_patterns = []

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
Expand All @@ -84,7 +86,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"

# 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
Expand All @@ -95,28 +97,28 @@
# 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.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
"**": [
"about.html",
"navigation.html",
"relations.html", # needs 'show_related': True theme option to display
"searchbox.html",
"donate.html",
]
}


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'PyPAPIdoc'
htmlhelp_basename = "PyPAPIdoc"


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -125,15 +127,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',
Expand All @@ -143,19 +142,21 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'PyPAPI.tex', u'PyPAPI Documentation',
u'Fabien LOISON, Mathilde BOUTIGNY', 'manual'),
(
master_doc,
"PyPAPI.tex",
"PyPAPI Documentation",
"Fabien LOISON, Mathilde BOUTIGNY",
"manual",
),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'pypapi', u'PyPAPI Documentation',
[author], 1)
]
man_pages = [(master_doc, "pypapi", "PyPAPI Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -164,10 +165,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'PyPAPI', u'PyPAPI Documentation',
author, 'PyPAPI', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"PyPAPI",
"PyPAPI Documentation",
author,
"PyPAPI",
"One line description of project.",
"Miscellaneous",
),
]



1 change: 1 addition & 0 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"pypapi",
"setup.py",
"noxfile.py",
"docs/conf.py",
]


Expand Down

0 comments on commit 831c00a

Please sign in to comment.