Skip to content

Commit 4e089e6

Browse files
committed
keep long string in sphinx conf.py
- exempt from black - exempt from flake8 - shortened other offending lines
1 parent cebf70f commit 4e089e6

1 file changed

Lines changed: 18 additions & 16 deletions

File tree

package/doc/sphinx/source/conf.py

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
# MDAnalysis documentation build configuration file, created by
44
# sphinx-quickstart on Mon Sep 27 09:39:55 2010.
55
#
6-
# This file is execfile()d with the current directory set to its containing dir.
6+
# This file is execfile()d with the current directory set to its containing
7+
# dir.
78
#
89
# Note that not all possible configuration values are present in this
910
# autogenerated file.
@@ -29,13 +30,13 @@
2930
# make sure sphinx always uses the current branch
3031
sys.path.insert(0, os.path.abspath("../../.."))
3132

32-
# -- General configuration -----------------------------------------------------
33+
# -- General configuration ----------------------------------------------------
3334

3435
# If your documentation needs a minimal Sphinx version, state it here.
3536
# needs_sphinx = '1.0'
3637

37-
# Add any Sphinx extension module names here, as strings. They can be extensions
38-
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
38+
# Add any Sphinx extension module names here, as strings. They can be
39+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3940
extensions = [
4041
"sphinx.ext.autodoc",
4142
"sphinx.ext.intersphinx",
@@ -70,10 +71,9 @@ class KeyStyle(UnsrtStyle):
7071
register_plugin("pybtex.style.labels", "keylabel", KeyLabelStyle)
7172
register_plugin("pybtex.style.formatting", "MDA", KeyStyle)
7273

73-
mathjax_path = (
74-
"https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js"
75-
"?config=TeX-AMS-MML_HTMLorMML"
76-
)
74+
75+
# fmt: off
76+
mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" # noqa: E501
7777

7878
# for sitemap with https://github.com/jdillard/sphinx-sitemap
7979
# This sitemap is correct both for the development and release docs, which
@@ -99,8 +99,8 @@ class KeyStyle(UnsrtStyle):
9999

100100
# General information about the project.
101101
# (take the list from AUTHORS)
102-
# Ordering: (1) Naveen (2) Elizabeth, then all contributors in alphabetical order
103-
# (last) Oliver
102+
# Ordering: (1) Naveen (2) Elizabeth, then all contributors in alphabetical
103+
# order (last) Oliver
104104
author_list = mda.__authors__
105105
authors = ", ".join(author_list[:-1]) + ", and " + author_list[-1]
106106
project = "MDAnalysis"
@@ -133,7 +133,8 @@ class KeyStyle(UnsrtStyle):
133133
# directories to ignore when looking for source files.
134134
exclude_patterns = ["_build"]
135135

136-
# The reST default role (used for this markup: `text`) to use for all documents.
136+
# The reST default role (used for this markup: `text`) to use for all
137+
# documents.
137138
# default_role = None
138139

139140
# If true, '()' will be appended to :func: etc. cross-reference text.
@@ -159,7 +160,7 @@ class KeyStyle(UnsrtStyle):
159160
# to prevent including of member entries in toctree
160161
toc_object_entries = False
161162

162-
# -- Options for HTML output ---------------------------------------------------
163+
# -- Options for HTML output --------------------------------------------------
163164

164165
# The theme to use for HTML and HTML Help pages. See the documentation for
165166
# a list of builtin themes.
@@ -249,7 +250,7 @@ class KeyStyle(UnsrtStyle):
249250
htmlhelp_basename = "MDAnalysisdoc"
250251

251252

252-
# -- Options for LaTeX output --------------------------------------------------
253+
# -- Options for LaTeX output -------------------------------------------------
253254

254255
# The paper size ('letter' or 'a4').
255256
# latex_paper_size = 'letter'
@@ -258,7 +259,8 @@ class KeyStyle(UnsrtStyle):
258259
# latex_font_size = '10pt'
259260

260261
# Grouping the document tree into LaTeX files. List of tuples
261-
# (source start file, target name, title, author, documentclass [howto/manual]).
262+
# (source start file, target name, title, author, documentclass
263+
# [howto/manual]).
262264
latex_documents = [
263265
("MDAnalysis.tex", "MDAnalysis Documentation", authors, "manual"),
264266
]
@@ -287,14 +289,14 @@ class KeyStyle(UnsrtStyle):
287289
# latex_domain_indices = True
288290

289291

290-
# -- Options for manual page output --------------------------------------------
292+
# -- Options for manual page output -------------------------------------------
291293

292294
# One entry per manual page. List of tuples
293295
# (source start file, name, description, authors, manual section).
294296
man_pages = [("mdanalysis", "MDAnalysis Documentation", [authors], 1)]
295297

296298

297-
# -- Options for Epub output ---------------------------------------------------
299+
# -- Options for Epub output --------------------------------------------------
298300

299301
# Bibliographic Dublin Core info.
300302
epub_title = "MDAnalysis"

0 commit comments

Comments
 (0)