Skip to content

Commit

Permalink
global: format with black
Browse files Browse the repository at this point in the history
* Addresses reanahub/reana#329.
  • Loading branch information
reana-team authored and Diego Rodriguez committed Jun 5, 2020
1 parent 0261e57 commit 67222ac
Show file tree
Hide file tree
Showing 22 changed files with 787 additions and 737 deletions.
101 changes: 50 additions & 51 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -34,35 +34,35 @@
# needs_sphinx = '1.0'

# Do not warn on external images.
suppress_warnings = ['image.nonlocal_uri']
suppress_warnings = ["image.nonlocal_uri"]

# 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.coverage',
'sphinx.ext.doctest',
'sphinx.ext.graphviz',
'sphinx.ext.intersphinx',
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
"sphinx.ext.graphviz",
"sphinx.ext.intersphinx",
]

# 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 = 'reana'
copyright = '2018, info@reana.io'
author = 'info@reana.io'
project = "reana"
copyright = "2018, info@reana.io"
author = "info@reana.io"

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand All @@ -72,9 +72,9 @@

# Get the version string. Cannot be done with import!
g = {}
with open(os.path.join('..', 'reana_commons', 'version.py'), 'rt') as fp:
with open(os.path.join("..", "reana_commons", "version.py"), "rt") as fp:
exec(fp.read(), g)
version = g['__version__']
version = g["__version__"]

# The full version, including alpha/beta/rc tags.
release = version
Expand All @@ -89,10 +89,10 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to 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"

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
Expand All @@ -103,53 +103,53 @@
# 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
# documentation.
#
html_theme_options = {
'logo': 'logo-reana.png',
'description': """<p>REANA-Commons is a component of the <a
"logo": "logo-reana.png",
"description": """<p>REANA-Commons is a component of the <a
href="http://www.reana.io">REANA</a> reusable and
reproducible research data analysis
platform.</p><p>REANA-Commons provides common utilities
and schemas shared by the REANA cluster
components.</p>""",
'github_user': 'reanahub',
'github_repo': 'reana-commons',
'github_button': False,
'github_banner': True,
'show_powered_by': False,
'extra_nav_links': {
'REANA@DockerHub': 'https://hub.docker.com/u/reanahub/',
'REANA@GitHub': 'https://github.com/reanahub',
'REANA@Twitter': 'https://twitter.com/reanahub',
'REANA@Web': 'http://www.reana.io',
}
"github_user": "reanahub",
"github_repo": "reana-commons",
"github_button": False,
"github_banner": True,
"show_powered_by": False,
"extra_nav_links": {
"REANA@DockerHub": "https://hub.docker.com/u/reanahub/",
"REANA@GitHub": "https://github.com/reanahub",
"REANA@Twitter": "https://twitter.com/reanahub",
"REANA@Web": "http://www.reana.io",
},
}

# 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, maps document names to template names.
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html',
'searchbox.html',
'donate.html',
"**": [
"about.html",
"navigation.html",
"relations.html",
"searchbox.html",
"donate.html",
]
}

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

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


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -158,15 +158,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 @@ -176,19 +173,15 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'reana.tex', 'reana Documentation',
'info@reana.io', 'manual'),
(master_doc, "reana.tex", "reana Documentation", "info@reana.io", "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, 'reana', 'reana Documentation',
[author], 1)
]
man_pages = [(master_doc, "reana", "reana Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -197,12 +190,18 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'reana', 'reana Documentation',
author, 'reana', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"reana",
"reana Documentation",
author,
"reana",
"One line description of project.",
"Miscellaneous",
),
]

# Intersphinx configuration
intersphinx_mapping = {
'kombu': ('http://docs.celeryproject.org/projects/kombu/en/latest/', None),
"kombu": ("http://docs.celeryproject.org/projects/kombu/en/latest/", None),
}
2 changes: 1 addition & 1 deletion reana_commons/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@

from .version import __version__

__all__ = ('__version__', )
__all__ = ("__version__",)

0 comments on commit 67222ac

Please sign in to comment.