Skip to content

Commit

Permalink
Reformat code with Black
Browse files Browse the repository at this point in the history
  • Loading branch information
apriha committed Apr 26, 2019
1 parent 318ad1e commit 7293588
Show file tree
Hide file tree
Showing 3 changed files with 302 additions and 198 deletions.
79 changes: 42 additions & 37 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,17 @@ class Mock(MagicMock):
def __getattr__(cls, name):
return MagicMock()

MOCK_MODULES = ['numpy', 'pandas', 'pandas.api.types', 'matplotlib', 'matplotlib.collections']

MOCK_MODULES = [
"numpy",
"pandas",
"pandas.api.types",
"matplotlib",
"matplotlib.collections",
]
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath("../"))

import lineage

Expand All @@ -46,31 +53,33 @@ def __getattr__(cls, name):
# 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',
'sphinx.ext.githubpages',
'sphinx.ext.napoleon']
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinx.ext.napoleon",
]

napoleon_google_docstring = False
napoleon_use_param = False
napoleon_use_ivar = True

# 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 = 'lineage'
copyright = '2017, Andrew Riha'
author = 'Andrew Riha'
project = "lineage"
copyright = "2017, Andrew Riha"
author = "Andrew Riha"

# 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 @@ -92,10 +101,10 @@ def __getattr__(cls, name):
# 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 @@ -117,28 +126,28 @@ def __getattr__(cls, name):
# 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 = 'lineagedoc'
htmlhelp_basename = "lineagedoc"


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -147,15 +156,12 @@ def __getattr__(cls, name):
# 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 @@ -165,19 +171,15 @@ def __getattr__(cls, name):
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'lineage.tex', 'lineage Documentation',
'Andrew Riha', 'manual'),
(master_doc, "lineage.tex", "lineage Documentation", "Andrew Riha", "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, 'lineage', 'lineage Documentation',
[author], 1)
]
man_pages = [(master_doc, "lineage", "lineage Documentation", [author], 1)]


# -- Options for Texinfo output -------------------------------------------
Expand All @@ -186,10 +188,13 @@ def __getattr__(cls, name):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'lineage', 'lineage Documentation',
author, 'lineage', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"lineage",
"lineage Documentation",
author,
"lineage",
"One line description of project.",
"Miscellaneous",
)
]



Loading

0 comments on commit 7293588

Please sign in to comment.