|
3 | 3 | # |
4 | 4 | # This file is execfile()d with the current directory set to its containing dir. |
5 | 5 | # |
6 | | -# The contents of this file are pickled, so don't put values in the namespace |
7 | | -#thataren'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). |
8 | 8 | # |
9 | | -# Note that not all possible configuration values are present in this |
10 | | -#autogeneratedfile. |
| 9 | +# Note that not all possible configuration values are present in this autogenerated |
| 10 | +# file. |
11 | 11 | # |
12 | | -# All configuration values have a default; values that are commented out |
13 | | -#serve to showthe default. |
| 12 | +# All configuration values have a default; values that are commented out serve to show |
| 13 | +# the default. |
14 | 14 |
|
15 | | -importsys |
16 | 15 | importos |
| 16 | +importsys |
17 | 17 |
|
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. |
21 | 20 | # sys.path.append(os.path.abspath('.')) |
22 | 21 | sys.path.insert(0,os.path.abspath("../..")) |
23 | 22 |
|
24 | 23 | # General configuration |
25 | 24 | # --------------------- |
26 | 25 |
|
27 | | -# Add any Sphinx extension module names here, as strings. They can be extensions |
28 | | -#comingwith 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. |
29 | 28 | extensions= ["sphinx.ext.autodoc","sphinx.ext.doctest"] |
30 | 29 |
|
31 | 30 | # Add any paths that contain templates here, relative to this directory. |
|
44 | 43 | project="GitPython" |
45 | 44 | copyright="Copyright (C) 2008, 2009 Michael Trier and contributors, 2010-2015 Sebastian Thiel" |
46 | 45 |
|
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. |
50 | 48 | # |
51 | 49 | # The short X.Y version. |
52 | 50 | withopen(os.path.join(os.path.dirname(__file__),"..","..","VERSION"))asfd: |
|
55 | 53 | # The full version, including alpha/beta/rc tags. |
56 | 54 | release=VERSION |
57 | 55 |
|
58 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
59 | | -#for a list ofsupported languages. |
| 56 | +# The language for content autogenerated by Sphinx. Refer to documentation for a list of |
| 57 | +# supported languages. |
60 | 58 | # language = None |
61 | 59 |
|
62 | 60 | # There are two options for replacing |today|: either, you set today to some |
|
68 | 66 | # List of documents that shouldn't be included in the build. |
69 | 67 | # unused_docs = [] |
70 | 68 |
|
71 | | -# List of directories, relative to source directory, that shouldn't be searched |
72 | | -#forsource files. |
| 69 | +# List of directories, relative to source directory, that shouldn't be searched for |
| 70 | +# source files. |
73 | 71 | exclude_trees= ["build"] |
74 | 72 |
|
75 | 73 | # The reST default role (used for this markup: `text`) to use for all documents. |
|
78 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. |
79 | 77 | # add_function_parentheses = True |
80 | 78 |
|
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::). |
83 | 81 | # add_module_names = True |
84 | 82 |
|
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. |
87 | 85 | # show_authors = False |
88 | 86 |
|
89 | 87 | # The name of the Pygments (syntax highlighting) style to use. |
|
96 | 94 | html_theme="sphinx_rtd_theme" |
97 | 95 | html_theme_options= {} |
98 | 96 |
|
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". |
101 | 99 | # html_title = None |
102 | 100 |
|
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. |
104 | 102 | # html_short_title = None |
105 | 103 |
|
106 | | -# The name of an image file (relative to this directory) to place at the top |
107 | | -#of thesidebar. |
| 104 | +# The name of an image file (relative to this directory) to place at the top of the |
| 105 | +# sidebar. |
108 | 106 | # html_logo = None |
109 | 107 |
|
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. |
113 | 110 | # html_favicon = None |
114 | 111 |
|
115 | | -# Add any paths that contain custom static files (such as style sheets) here, |
116 | | -#relativeto 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". |
118 | 115 | html_static_path= [] |
119 | 116 |
|
120 | | -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
121 | | -#using thegiven strftime format. |
| 117 | +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, using the |
| 118 | +# given strftime format. |
122 | 119 | # html_last_updated_fmt = '%b %d, %Y' |
123 | 120 |
|
124 | | -# If true, SmartyPants will be used to convert quotes and dashes to |
125 | | -#typographicallycorrect entities. |
| 121 | +# If true, SmartyPants will be used to convert quotes and dashes to typographically |
| 122 | +# correct entities. |
126 | 123 | # html_use_smartypants = True |
127 | 124 |
|
128 | 125 | # Custom sidebar templates, maps document names to template names. |
129 | 126 | # html_sidebars = {} |
130 | 127 |
|
131 | | -# Additional templates that should be rendered to pages, maps page names to |
132 | | -#templatenames. |
| 128 | +# Additional templates that should be rendered to pages, maps page names to template |
| 129 | +# names. |
133 | 130 | # html_additional_pages = {} |
134 | 131 |
|
135 | 132 | # If false, no module index is generated. |
|
144 | 141 | # If true, the reST sources are included in the HTML build as _sources/<name>. |
145 | 142 | # html_copy_source = True |
146 | 143 |
|
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 whichthe 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. |
150 | 147 | # html_use_opensearch = '' |
151 | 148 |
|
152 | 149 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
|
171 | 168 | ("index","GitPython.tex","GitPython Documentation","Michael Trier","manual"), |
172 | 169 | ] |
173 | 170 |
|
174 | | -# The name of an image file (relative to this directory) to place at the top of |
175 | | -#thetitle page. |
| 171 | +# The name of an image file (relative to this directory) to place at the top of the |
| 172 | +# title page. |
176 | 173 | # latex_logo = None |
177 | 174 |
|
178 | 175 | # For "manual" documents, if this is true, then toplevel headings are parts, |
|