3131# Add any Sphinx extension module names here, as strings. They can be
3232# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3333# ones.
34- extensions = ['sphinx.ext.extlinks' ,
35- 'sphinxcontrib.autoprogram' ,
36- 'recommonmark' ,
37- ]
34+ extensions = ["sphinx.ext.extlinks" , "sphinxcontrib.autoprogram" , "recommonmark" ]
3835
3936extlinks = {
40- ' issue' : (' https://github.com/jupyter/repo2docker/issues/%s' , ' Issue #' ),
41- 'pr' : (' https://github.com/jupyter/repo2docker/pull/%s' , ' PR #' ),
42- ' user' : (' https://github.com/%s' , '@' ),
37+ " issue" : (" https://github.com/jupyter/repo2docker/issues/%s" , " Issue #" ),
38+ "pr" : (" https://github.com/jupyter/repo2docker/pull/%s" , " PR #" ),
39+ " user" : (" https://github.com/%s" , "@" ),
4340}
4441
4542# Add any paths that contain templates here, relative to this directory.
46- templates_path = [' _templates' ]
43+ templates_path = [" _templates" ]
4744
4845
4946from recommonmark .transform import AutoStructify
5047
48+
5149def setup (app ):
52- app .add_stylesheet (' custom.css' ) # may also be a URL
53- app .add_config_value ('recommonmark_config' , {
54- ' auto_toc_tree_section' : ' Contents' ,
55- }, True )
50+ app .add_stylesheet (" custom.css" ) # may also be a URL
51+ app .add_config_value (
52+ "recommonmark_config" , { " auto_toc_tree_section" : " Contents" }, True
53+ )
5654 app .add_transform (AutoStructify )
5755
5856
5957# The suffix(es) of source filenames.
6058# You can specify multiple suffix as a list of string:
6159#
6260# source_suffix = ['.rst', '.md']
63- source_suffix = [' .rst' , ' .md' ]
61+ source_suffix = [" .rst" , " .md" ]
6462
6563# The master toctree document.
66- master_doc = ' index'
64+ master_doc = " index"
6765
6866# General information about the project.
69- project = ' repo2docker'
70- copyright = ' 2019, Project Jupyter'
71- author = ' Project Jupyter'
67+ project = " repo2docker"
68+ copyright = " 2019, Project Jupyter"
69+ author = " Project Jupyter"
7270
7371# The version info for the project you're documenting, acts as replacement for
7472# |version| and |release|, also used in various other places throughout the
7573# built documents.
7674#
7775# The short X.Y version.
7876import repo2docker
77+
7978version = repo2docker .__version__
8079# The full version, including alpha/beta/rc tags.
8180release = version
8281
8382from repo2docker .buildpacks .conda import CondaBuildPack
8483
85- default_python = CondaBuildPack .major_pythons ['3' ]
84+ default_python = CondaBuildPack .major_pythons ["3" ]
8685
8786rst_prolog = """
8887.. |default_python| replace:: **Python {default_python}**
8988.. |default_python_version| replace:: {default_python}
90- """ .format (default_python = default_python )
89+ """ .format (
90+ default_python = default_python
91+ )
9192
9293# The language for content autogenerated by Sphinx. Refer to documentation
9394# for a list of supported languages.
@@ -102,22 +103,23 @@ def setup(app):
102103exclude_patterns = []
103104
104105# The name of the Pygments (syntax highlighting) style to use.
105- pygments_style = ' sphinx'
106+ pygments_style = " sphinx"
106107
107108# If true, `todo` and `todoList` produce output, else they produce nothing.
108109todo_include_todos = False
109110
110111# repo2docker Logo
111- html_logo = ' _static/images/repo2docker.svg'
112- html_favicon = ' _static/images/favicon.ico'
112+ html_logo = " _static/images/repo2docker.svg"
113+ html_favicon = " _static/images/favicon.ico"
113114
114115# -- Options for HTML output ----------------------------------------------
115116
116117# The theme to use for HTML and HTML Help pages. See the documentation for
117118# a list of builtin themes.
118119#
119120import alabaster_jupyterhub
120- html_theme = 'alabaster_jupyterhub'
121+
122+ html_theme = "alabaster_jupyterhub"
121123html_theme_path = [alabaster_jupyterhub .get_html_theme_path ()]
122124
123125# Theme options are theme-specific and customize the look and feel of a theme
@@ -129,13 +131,15 @@ def setup(app):
129131# Add any paths that contain custom static files (such as style sheets) here,
130132# relative to this directory. They are copied after the builtin static files,
131133# so a file named "default.css" will overwrite the builtin "default.css".
132- html_static_path = ['_static' ]
133- html_sidebars = { '**' : ['globaltoc.html' , 'relations.html' , 'sourcelink.html' , 'searchbox.html' ] }
134+ html_static_path = ["_static" ]
135+ html_sidebars = {
136+ "**" : ["globaltoc.html" , "relations.html" , "sourcelink.html" , "searchbox.html" ]
137+ }
134138
135139# -- Options for HTMLHelp output ------------------------------------------
136140
137141# Output file base name for HTML help builder.
138- htmlhelp_basename = ' repo2dockerdoc'
142+ htmlhelp_basename = " repo2dockerdoc"
139143
140144
141145# -- Options for LaTeX output ---------------------------------------------
@@ -144,15 +148,12 @@ def setup(app):
144148 # The paper size ('letterpaper' or 'a4paper').
145149 #
146150 # 'papersize': 'letterpaper',
147-
148151 # The font size ('10pt', '11pt' or '12pt').
149152 #
150153 # 'pointsize': '10pt',
151-
152154 # Additional stuff for the LaTeX preamble.
153155 #
154156 # 'preamble': '',
155-
156157 # Latex figure (float) alignment
157158 #
158159 # 'figure_align': 'htbp',
@@ -162,19 +163,21 @@ def setup(app):
162163# (source start file, target name, title,
163164# author, documentclass [howto, manual, or own class]).
164165latex_documents = [
165- (master_doc , 'repo2docker.tex' , 'repo2docker Documentation' ,
166- 'Project Jupyter' , 'manual' ),
166+ (
167+ master_doc ,
168+ "repo2docker.tex" ,
169+ "repo2docker Documentation" ,
170+ "Project Jupyter" ,
171+ "manual" ,
172+ )
167173]
168174
169175
170176# -- Options for manual page output ---------------------------------------
171177
172178# One entry per manual page. List of tuples
173179# (source start file, name, description, authors, manual section).
174- man_pages = [
175- (master_doc , 'repo2docker' , 'repo2docker Documentation' ,
176- [author ], 1 )
177- ]
180+ man_pages = [(master_doc , "repo2docker" , "repo2docker Documentation" , [author ], 1 )]
178181
179182
180183# -- Options for Texinfo output -------------------------------------------
@@ -183,13 +186,18 @@ def setup(app):
183186# (source start file, target name, title, author,
184187# dir menu entry, description, category)
185188texinfo_documents = [
186- (master_doc , 'repo2docker' , 'repo2docker Documentation' ,
187- author , 'repo2docker' , 'One line description of project.' ,
188- 'Miscellaneous' ),
189+ (
190+ master_doc ,
191+ "repo2docker" ,
192+ "repo2docker Documentation" ,
193+ author ,
194+ "repo2docker" ,
195+ "One line description of project." ,
196+ "Miscellaneous" ,
197+ )
189198]
190199
191200
192-
193201# -- Options for Epub output ----------------------------------------------
194202
195203# Bibliographic Dublin Core info.
@@ -208,4 +216,4 @@ def setup(app):
208216# epub_uid = ''
209217
210218# A list of files that should not be packed into the epub file.
211- epub_exclude_files = [' search.html' ]
219+ epub_exclude_files = [" search.html" ]
0 commit comments