Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@
with open("../../neo/version.py") as fp:
d = {}
exec(fp.read(), d)
neo_release = d['version']
neo_release = d["version"]

neo_version = '.'.join(str(e) for e in LooseVersion(neo_release).version[:2])
neo_version = ".".join(str(e) for e in LooseVersion(neo_release).version[:2])


AUTHORS = 'Neo authors and contributors <neuralensemble@googlegroups.com>'
AUTHORS = "Neo authors and contributors <neuralensemble@googlegroups.com>"

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand All @@ -35,23 +35,23 @@

# 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.todo']
extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest", "sphinx.ext.todo"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = '.rst'
source_suffix = ".rst"

# The encoding of source files.
# source_encoding = 'utf-8'

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# General information about the project.
project = 'Neo'
copyright = '2010-2020, ' + AUTHORS
project = "Neo"
copyright = "2010-2020, " + AUTHORS

# 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 Down Expand Up @@ -95,7 +95,7 @@
# show_authors = False

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

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
Expand All @@ -106,7 +106,7 @@
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme = 'default'
html_theme = 'sphinxdoc'
html_theme = "sphinxdoc"
# html_theme = 'haiku'
# html_theme = 'scrolls'
# html_theme = 'agogo'
Expand All @@ -128,7 +128,7 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'images/neologo_light.png'
html_logo = "images/neologo_light.png"


# The name of an image file (within the static path) to use as favicon of the
Expand All @@ -140,7 +140,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 = ['images']
html_static_path = ["images"]

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down Expand Up @@ -178,7 +178,7 @@
# html_file_suffix = ''

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


# -- Options for LaTeX output -------------------------------------------------
Expand All @@ -192,8 +192,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author,
# documentclass [howto/manual]).
latex_documents = [('index', 'neo.tex', 'Neo Documentation',
AUTHORS, 'manual')]
latex_documents = [("index", "neo.tex", "Neo Documentation", AUTHORS, "manual")]

# The name of an image file (relative to this directory) to place at the
# top of the title page.
Expand All @@ -216,4 +215,6 @@

rst_epilog = """
.. |neo_github_url| replace:: https://github.com/NeuralEnsemble/python-neo/archive/neo-{}.zip
""".format(neo_release)
""".format(
neo_release
)
Loading