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.
2930# make sure sphinx always uses the current branch
3031sys .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.
3940extensions = [
4041 "sphinx.ext.autodoc" ,
4142 "sphinx.ext.intersphinx" ,
@@ -70,10 +71,8 @@ class KeyStyle(UnsrtStyle):
7071register_plugin ("pybtex.style.labels" , "keylabel" , KeyLabelStyle )
7172register_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+ mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML" # noqa: E501; fmt: skip
7776
7877# for sitemap with https://github.com/jdillard/sphinx-sitemap
7978# This sitemap is correct both for the development and release docs, which
@@ -99,8 +98,8 @@ class KeyStyle(UnsrtStyle):
9998
10099# General information about the project.
101100# (take the list from AUTHORS)
102- # Ordering: (1) Naveen (2) Elizabeth, then all contributors in alphabetical order
103- # (last) Oliver
101+ # Ordering: (1) Naveen (2) Elizabeth, then all contributors in alphabetical
102+ # order (last) Oliver
104103author_list = mda .__authors__
105104authors = ", " .join (author_list [:- 1 ]) + ", and " + author_list [- 1 ]
106105project = "MDAnalysis"
@@ -133,7 +132,8 @@ class KeyStyle(UnsrtStyle):
133132# directories to ignore when looking for source files.
134133exclude_patterns = ["_build" ]
135134
136- # The reST default role (used for this markup: `text`) to use for all documents.
135+ # The reST default role (used for this markup: `text`) to use for all
136+ # documents.
137137# default_role = None
138138
139139# If true, '()' will be appended to :func: etc. cross-reference text.
@@ -159,7 +159,7 @@ class KeyStyle(UnsrtStyle):
159159# to prevent including of member entries in toctree
160160toc_object_entries = False
161161
162- # -- Options for HTML output ---------------------------------------------------
162+ # -- Options for HTML output --------------------------------------------------
163163
164164# The theme to use for HTML and HTML Help pages. See the documentation for
165165# a list of builtin themes.
@@ -249,7 +249,7 @@ class KeyStyle(UnsrtStyle):
249249htmlhelp_basename = "MDAnalysisdoc"
250250
251251
252- # -- Options for LaTeX output --------------------------------------------------
252+ # -- Options for LaTeX output -------------------------------------------------
253253
254254# The paper size ('letter' or 'a4').
255255# latex_paper_size = 'letter'
@@ -258,7 +258,8 @@ class KeyStyle(UnsrtStyle):
258258# latex_font_size = '10pt'
259259
260260# Grouping the document tree into LaTeX files. List of tuples
261- # (source start file, target name, title, author, documentclass [howto/manual]).
261+ # (source start file, target name, title, author, documentclass
262+ # [howto/manual]).
262263latex_documents = [
263264 ("MDAnalysis.tex" , "MDAnalysis Documentation" , authors , "manual" ),
264265]
@@ -287,14 +288,14 @@ class KeyStyle(UnsrtStyle):
287288# latex_domain_indices = True
288289
289290
290- # -- Options for manual page output --------------------------------------------
291+ # -- Options for manual page output -------------------------------------------
291292
292293# One entry per manual page. List of tuples
293294# (source start file, name, description, authors, manual section).
294295man_pages = [("mdanalysis" , "MDAnalysis Documentation" , [authors ], 1 )]
295296
296297
297- # -- Options for Epub output ---------------------------------------------------
298+ # -- Options for Epub output --------------------------------------------------
298299
299300# Bibliographic Dublin Core info.
300301epub_title = "MDAnalysis"
0 commit comments