@@ -8,7 +8,7 @@ import re
88import sys
99
1010sys .path .append (os .path .abspath ('.' ))
11- sys .path .append (os .path .abspath ('..' ))
11+ sys .path .append (os .path .abspath (".." ))
1212
1313# this package
1414from __pkginfo__ import __version__
@@ -27,56 +27,56 @@ project = "hello-world"
2727slug = re .sub (r'\W+' , '-' , project .lower ())
2828release = version = __version__
2929copyright = "2020-2021 E. Xample" # pylint: disable=redefined-builtin
30- language = 'en'
30+ language = "en"
3131package_root = "hello_world"
3232
3333extensions = [
34- ' sphinx_toolbox' ,
35- ' sphinx_toolbox.more_autodoc' ,
36- ' sphinx_toolbox.more_autosummary' ,
37- ' sphinx_toolbox.tweaks.param_dash' ,
38- ' sphinx.ext.intersphinx' ,
39- ' sphinx.ext.mathjax' ,
40- ' sphinxcontrib.httpdomain' ,
41- ' sphinxcontrib.extras_require' ,
42- ' sphinx.ext.todo' ,
43- ' sphinxemoji.sphinxemoji' ,
44- ' notfound.extension' ,
45- ' sphinx_copybutton' ,
46- ' sphinxcontrib.default_values' ,
47- ' sphinxcontrib.toctree_plus' ,
48- ' seed_intersphinx_mapping' ,
34+ " sphinx_toolbox" ,
35+ " sphinx_toolbox.more_autodoc" ,
36+ " sphinx_toolbox.more_autosummary" ,
37+ " sphinx_toolbox.tweaks.param_dash" ,
38+ " sphinx.ext.intersphinx" ,
39+ " sphinx.ext.mathjax" ,
40+ " sphinxcontrib.httpdomain" ,
41+ " sphinxcontrib.extras_require" ,
42+ " sphinx.ext.todo" ,
43+ " sphinxemoji.sphinxemoji" ,
44+ " notfound.extension" ,
45+ " sphinx_copybutton" ,
46+ " sphinxcontrib.default_values" ,
47+ " sphinxcontrib.toctree_plus" ,
48+ " seed_intersphinx_mapping" ,
4949 ]
5050
51- sphinxemoji_style = ' twemoji'
51+ sphinxemoji_style = " twemoji"
5252todo_include_todos = bool (os .environ .get ("SHOW_TODOS" , 0 ))
5353gitstamp_fmt = "%d %b %Y"
5454
55- templates_path = [' _templates' ]
56- html_static_path = [' _static' ]
57- source_suffix = ' .rst'
55+ templates_path = [" _templates" ]
56+ html_static_path = [" _static" ]
57+ source_suffix = " .rst"
5858exclude_patterns = []
5959
60- master_doc = ' index'
61- suppress_warnings = [' image.nonlocal_uri' ]
62- pygments_style = ' default'
60+ master_doc = " index"
61+ suppress_warnings = [" image.nonlocal_uri" ]
62+ pygments_style = " default"
6363
6464intersphinx_mapping = {
65- ' python' : (' https://docs.python.org/3/' , None ),
66- ' sphinx' : (' https://www.sphinx-doc.org/en/stable/' , None ),
65+ " python" : (" https://docs.python.org/3/" , None ),
66+ " sphinx" : (" https://www.sphinx-doc.org/en/stable/" , None ),
6767 }
6868
69- html_theme = ' alabaster'
69+ html_theme = " alabaster"
7070html_theme_options = {
71- ' page_width' : ' 1200px' ,
72- ' logo_name' : ' true' ,
73- ' github_user' : ' octocat' ,
74- ' github_repo' : ' hello-world' ,
75- ' description' : ' a short description' ,
76- ' github_banner' : ' true' ,
77- ' github_type' : ' star' ,
78- ' badge_branch' : ' master' ,
79- ' fixed_sidebar' : ' true' ,
71+ " page_width" : " 1200px" ,
72+ " logo_name" : " true" ,
73+ " github_user" : " octocat" ,
74+ " github_repo" : " hello-world" ,
75+ " description" : " a short description" ,
76+ " github_banner" : " true" ,
77+ " github_type" : " star" ,
78+ " badge_branch" : " master" ,
79+ " fixed_sidebar" : " true" ,
8080 }
8181html_theme_path = ["../.." ]
8282html_show_sourcelink = True # True will show link to source
@@ -85,9 +85,9 @@ html_context = {}
8585
8686htmlhelp_basename = slug
8787
88- latex_documents = [(' index' , f'{ slug } .tex' , project , author , ' manual' )]
89- man_pages = [(' index' , slug , project , [author ], 1 )]
90- texinfo_documents = [(' index' , slug , project , author , slug , project , ' Miscellaneous' )]
88+ latex_documents = [(" index" , f'{ slug } .tex' , project , author , " manual" )]
89+ man_pages = [(" index" , slug , project , [author ], 1 )]
90+ texinfo_documents = [(" index" , slug , project , author , slug , project , " Miscellaneous" )]
9191
9292toctree_plus_types = {
9393 "class" ,
@@ -131,9 +131,9 @@ autodoc_exclude_members = [ # Exclude "standard" methods.
131131 "__hash__" ,
132132 ]
133133autodoc_default_options = {
134- ' members' : None , # Include all members (methods).
135- ' special-members' : None ,
134+ " members" : None , # Include all members (methods).
135+ " special-members" : None ,
136136 "autosummary" : None ,
137137 "show-inheritance" : None ,
138- ' exclude-members' : ',' .join (autodoc_exclude_members ),
138+ " exclude-members" : ',' .join (autodoc_exclude_members ),
139139 }
0 commit comments