Skip to content

Commit 0969db9

Browse files
committed
Put Sphinx conf.py in the same style as other code
This is mostly a change to comments.
1 parent 7ab0933 commit 0969db9

File tree

1 file changed

+42
-45
lines changed

1 file changed

+42
-45
lines changed

Diff for: doc/source/conf.py

+42-45
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,28 @@
33
#
44
# This file is execfile()d with the current directory set to its containing dir.
55
#
6-
# The contents of this file are pickled, so don't put values in the namespace
7-
# that aren't pickleable (module imports are okay, they're removed automatically).
6+
# The contents of this file are pickled, so don't put values in the namespace that
7+
# aren't pickleable (module imports are okay, they're removed automatically).
88
#
9-
# Note that not all possible configuration values are present in this
10-
# autogenerated file.
9+
# Note that not all possible configuration values are present in this autogenerated
10+
# file.
1111
#
12-
# All configuration values have a default; values that are commented out
13-
# serve to show the default.
12+
# All configuration values have a default; values that are commented out serve to show
13+
# the default.
1414

15-
import sys
1615
import os
16+
import sys
1717

18-
# If your extensions are in another directory, add it here. If the directory
19-
# is relative to the documentation root, use os.path.abspath to make it
20-
# absolute, like shown here.
18+
# If your extensions are in another directory, add it here. If the directory is relative
19+
# to the documentation root, use os.path.abspath to make it absolute, like shown here.
2120
# sys.path.append(os.path.abspath('.'))
2221
sys.path.insert(0, os.path.abspath("../.."))
2322

2423
# General configuration
2524
# ---------------------
2625

27-
# Add any Sphinx extension module names here, as strings. They can be extensions
28-
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
26+
# Add any Sphinx extension module names here, as strings. They can be extensions coming
27+
# with Sphinx (named 'sphinx.ext.*') or your custom ones.
2928
extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"]
3029

3130
# Add any paths that contain templates here, relative to this directory.
@@ -44,9 +43,8 @@
4443
project = "GitPython"
4544
copyright = "Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel"
4645

47-
# The version info for the project you're documenting, acts as replacement for
48-
# |version| and |release|, also used in various other places throughout the
49-
# built documents.
46+
# The version info for the project you're documenting, acts as replacement for |version|
47+
# and |release|, also used in various other places throughout the built documents.
5048
#
5149
# The short X.Y version.
5250
with open(os.path.join(os.path.dirname(__file__), "..", "..", "VERSION")) as fd:
@@ -55,8 +53,8 @@
5553
# The full version, including alpha/beta/rc tags.
5654
release = VERSION
5755

58-
# The language for content autogenerated by Sphinx. Refer to documentation
59-
# for a list of supported languages.
56+
# The language for content autogenerated by Sphinx. Refer to documentation for a list of
57+
# supported languages.
6058
# language = None
6159

6260
# There are two options for replacing |today|: either, you set today to some
@@ -68,8 +66,8 @@
6866
# List of documents that shouldn't be included in the build.
6967
# unused_docs = []
7068

71-
# List of directories, relative to source directory, that shouldn't be searched
72-
# for source files.
69+
# List of directories, relative to source directory, that shouldn't be searched for
70+
# source files.
7371
exclude_trees = ["build"]
7472

7573
# The reST default role (used for this markup: `text`) to use for all documents.
@@ -78,12 +76,12 @@
7876
# If true, '()' will be appended to :func: etc. cross-reference text.
7977
# add_function_parentheses = True
8078

81-
# If true, the current module name will be prepended to all description
82-
# unit titles (such as .. function::).
79+
# If true, the current module name will be prepended to all description unit titles
80+
# (such as .. function::).
8381
# add_module_names = True
8482

85-
# If true, sectionauthor and moduleauthor directives will be shown in the
86-
# output. They are ignored by default.
83+
# If true, sectionauthor and moduleauthor directives will be shown in the output.
84+
# They are ignored by default.
8785
# show_authors = False
8886

8987
# The name of the Pygments (syntax highlighting) style to use.
@@ -96,40 +94,39 @@
9694
html_theme = "sphinx_rtd_theme"
9795
html_theme_options = {}
9896

99-
# The name for this set of Sphinx documents. If None, it defaults to
100-
# "<project> v<release> documentation".
97+
# The name for this set of Sphinx documents.
98+
# If None, it defaults to "<project> v<release> documentation".
10199
# html_title = None
102100

103-
# A shorter title for the navigation bar. Default is the same as html_title.
101+
# A shorter title for the navigation bar. Default is the same as html_title.
104102
# html_short_title = None
105103

106-
# The name of an image file (relative to this directory) to place at the top
107-
# of the sidebar.
104+
# The name of an image file (relative to this directory) to place at the top of the
105+
# sidebar.
108106
# html_logo = None
109107

110-
# The name of an image file (within the static path) to use as favicon of the
111-
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
112-
# pixels large.
108+
# The name of an image file (within the static path) to use as favicon of the docs.
109+
# This file should be a Windows icon file (.ico) being 16x16 or 32x32 pixels large.
113110
# html_favicon = None
114111

115-
# Add any paths that contain custom static files (such as style sheets) here,
116-
# relative to this directory. They are copied after the builtin static files,
117-
# so a file named "default.css" will overwrite the builtin "default.css".
112+
# Add any paths that contain custom static files (such as style sheets) here, relative
113+
# to this directory. They are copied after the builtin static files, so a file named
114+
# "default.css" will overwrite the builtin "default.css".
118115
html_static_path = []
119116

120-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
121-
# using the given strftime format.
117+
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, using the
118+
# given strftime format.
122119
# html_last_updated_fmt = '%b %d, %Y'
123120

124-
# If true, SmartyPants will be used to convert quotes and dashes to
125-
# typographically correct entities.
121+
# If true, SmartyPants will be used to convert quotes and dashes to typographically
122+
# correct entities.
126123
# html_use_smartypants = True
127124

128125
# Custom sidebar templates, maps document names to template names.
129126
# html_sidebars = {}
130127

131-
# Additional templates that should be rendered to pages, maps page names to
132-
# template names.
128+
# Additional templates that should be rendered to pages, maps page names to template
129+
# names.
133130
# html_additional_pages = {}
134131

135132
# If false, no module index is generated.
@@ -144,9 +141,9 @@
144141
# If true, the reST sources are included in the HTML build as _sources/<name>.
145142
# html_copy_source = True
146143

147-
# If true, an OpenSearch description file will be output, and all pages will
148-
# contain a <link> tag referring to it. The value of this option must be the
149-
# base URL from which the finished HTML is served.
144+
# If true, an OpenSearch description file will be output, and all pages will contain a
145+
# <link> tag referring to it. The value of this option must be the base URL from which
146+
# the finished HTML is served.
150147
# html_use_opensearch = ''
151148

152149
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
@@ -171,8 +168,8 @@
171168
("index", "GitPython.tex", "GitPython Documentation", "Michael Trier", "manual"),
172169
]
173170

174-
# The name of an image file (relative to this directory) to place at the top of
175-
# the title page.
171+
# The name of an image file (relative to this directory) to place at the top of the
172+
# title page.
176173
# latex_logo = None
177174

178175
# For "manual" documents, if this is true, then toplevel headings are parts,

0 commit comments

Comments
 (0)