2018-06-28 00:39:55 -07:00
|
|
|
# Support markdown too
|
|
|
|
|
source_suffix = ['.rst']
|
|
|
|
|
|
|
|
|
|
project = 'The Littlest JupyterHub'
|
|
|
|
|
copyright = '2018, JupyterHub Team'
|
|
|
|
|
author = 'JupyterHub Team'
|
|
|
|
|
|
|
|
|
|
# The short X.Y version
|
|
|
|
|
version = ''
|
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
|
|
|
release = 'v0.1'
|
|
|
|
|
|
2018-07-05 17:51:51 -07:00
|
|
|
# Add custom CSS/Javascript
|
|
|
|
|
def setup(app):
|
|
|
|
|
app.add_javascript("custom.js")
|
|
|
|
|
app.add_stylesheet("custom.css")
|
|
|
|
|
app.add_javascript("https://cdn.jsdelivr.net/npm/clipboard@1/dist/clipboard.min.js")
|
|
|
|
|
|
2018-06-28 11:54:36 -07:00
|
|
|
# Enable MathJax for Math
|
2018-08-10 17:26:35 -07:00
|
|
|
extensions = ['sphinx.ext.mathjax', 'sphinx_copybutton.sphinx_copybutton']
|
2018-06-28 11:54:36 -07:00
|
|
|
|
2018-06-28 00:39:55 -07:00
|
|
|
# The master toctree document.
|
|
|
|
|
master_doc = 'index'
|
|
|
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
|
# directories to ignore when looking for source files.
|
|
|
|
|
# This pattern also affects html_static_path and html_extra_path .
|
2018-08-03 16:29:00 +02:00
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store',
|
|
|
|
|
'tutorials/custom.rst']
|
2018-06-28 00:39:55 -07:00
|
|
|
|
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
|
|
|
pygments_style = 'sphinx'
|
|
|
|
|
|
|
|
|
|
html_theme = 'alabaster'
|
|
|
|
|
|
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
|
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
|
|
|
html_static_path = ['_static']
|
2018-07-28 13:44:39 -07:00
|
|
|
|
2018-07-30 10:21:07 -07:00
|
|
|
# Configure the sidebar to be how we want it to be
|
|
|
|
|
# We don't have 'navigation' here, since it is very cluttered
|
|
|
|
|
# and seems to be hard to control.
|
2018-07-29 23:36:56 -07:00
|
|
|
html_sidebars = {
|
|
|
|
|
'**': [
|
|
|
|
|
'about.html',
|
|
|
|
|
'relations.html',
|
|
|
|
|
'searchbox.html',
|
|
|
|
|
'donate.html',
|
|
|
|
|
]
|
|
|
|
|
}
|
2018-07-28 13:44:39 -07:00
|
|
|
# Custom Alabaster theme options
|
|
|
|
|
html_theme_options = {
|
2018-07-30 10:21:07 -07:00
|
|
|
'description': """
|
|
|
|
|
A simple JupyterHub distribution for 1-100 users
|
|
|
|
|
<br /> <br />
|
|
|
|
|
<strong>Documentation confusing?</strong> <a href="https://github.com/jupyterhub/the-littlest-jupyterhub/issues">File an issue!</a>
|
|
|
|
|
""",
|
2018-07-28 13:44:39 -07:00
|
|
|
'github_user': 'jupyterhub',
|
|
|
|
|
'github_repo': 'the-littlest-jupyterhub',
|
2018-07-29 23:36:56 -07:00
|
|
|
'github_button': True,
|
|
|
|
|
'github_banner': True,
|
2018-07-28 13:44:39 -07:00
|
|
|
}
|