hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-08 02:24:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

blacken conf.py

Browse Source
This commit is contained in:
Carol Willing
2018-06-06 12:52:30 -07:00
parent cc6968e225
commit ff7851ee2e
1 changed files with 39 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
docs/source/conf.py
View File

@@ -35,12 +35,14 @@ author = u'Project Jupyter team'
# Autopopulate version # Autopopulate version
from os.path import dirname from os.path import dirname
docs = dirname(dirname(__file__)) docs = dirname(dirname(__file__))
root = dirname(docs) root = dirname(docs)
sys.path.insert(0, root) sys.path.insert(0, root)
sys.path.insert(0, os.path.join(docs, 'sphinxext')) sys.path.insert(0, os.path.join(docs, 'sphinxext'))
import jupyterhub import jupyterhub
# The short X.Y version. # The short X.Y version.
version = '%i.%i' % jupyterhub.version_info[:2] version = '%i.%i' % jupyterhub.version_info[:2]
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
@@ -56,12 +58,10 @@ default_role = 'literal'
# -- Source ------------------------------------------------------------- # -- Source -------------------------------------------------------------
source_parsers = { source_parsers = {'.md': 'recommonmark.parser.CommonMarkParser'}
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md'] source_suffix = ['.rst', '.md']
#source_encoding = 'utf-8-sig' # source_encoding = 'utf-8-sig'
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
@@ -96,7 +96,7 @@ html_sidebars = {
'navigation.html', 'navigation.html',
'relations.html', 'relations.html',
'sourcelink.html', 'sourcelink.html',
], ]
} }
htmlhelp_basename = 'JupyterHubdoc' htmlhelp_basename = 'JupyterHubdoc'
@@ -104,38 +104,40 @@ htmlhelp_basename = 'JupyterHubdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
#'papersize': 'letterpaper', # 'papersize': 'letterpaper',
#'pointsize': '10pt', # 'pointsize': '10pt',
#'preamble': '', # 'preamble': '',
#'figure_align': 'htbp', # 'figure_align': 'htbp',
} }
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'JupyterHub.tex', u'JupyterHub Documentation', (
u'Project Jupyter team', 'manual'), master_doc,
'JupyterHub.tex',
u'JupyterHub Documentation',
u'Project Jupyter team',
'manual',
)
] ]
#latex_logo = None # latex_logo = None
#latex_use_parts = False # latex_use_parts = False
#latex_show_pagerefs = False # latex_show_pagerefs = False
#latex_show_urls = False # latex_show_urls = False
#latex_appendices = [] # latex_appendices = []
#latex_domain_indices = True # latex_domain_indices = True
# -- manual page output ------------------------------------------------- # -- manual page output -------------------------------------------------
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [(master_doc, 'jupyterhub', u'JupyterHub Documentation', [author], 1)]
(master_doc, 'jupyterhub', u'JupyterHub Documentation',
[author], 1)
]
#man_show_urls = False # man_show_urls = False
# -- Texinfo output ----------------------------------------------------- # -- Texinfo output -----------------------------------------------------
@@ -144,15 +146,21 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'JupyterHub', u'JupyterHub Documentation', (
author, 'JupyterHub', 'One line description of project.', master_doc,
'Miscellaneous'), 'JupyterHub',
u'JupyterHub Documentation',
author,
'JupyterHub',
'One line description of project.',
'Miscellaneous',
)
] ]
#texinfo_appendices = [] # texinfo_appendices = []
#texinfo_domain_indices = True # texinfo_domain_indices = True
#texinfo_show_urls = 'footnote' # texinfo_show_urls = 'footnote'
#texinfo_no_detailmenu = False # texinfo_no_detailmenu = False
# -- Epub output -------------------------------------------------------- # -- Epub output --------------------------------------------------------
@@ -179,6 +187,7 @@ else:
# readthedocs.org uses their theme by default, so no need to specify it # readthedocs.org uses their theme by default, so no need to specify it
# build rest-api, since RTD doesn't run make # build rest-api, since RTD doesn't run make
from subprocess import check_call as sh from subprocess import check_call as sh
sh(['make', 'rest-api'], cwd=docs) sh(['make', 'rest-api'], cwd=docs)
# -- Spell checking ------------------------------------------------------- # -- Spell checking -------------------------------------------------------
@@ -190,4 +199,4 @@ except ImportError:
else: else:
extensions.append("sphinxcontrib.spelling") extensions.append("sphinxcontrib.spelling")
spelling_word_list_filename='spelling_wordlist.txt' spelling_word_list_filename = 'spelling_wordlist.txt'