mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-07 10:04:07 +00:00
updating to pandas docs theme
This commit is contained in:
Chris Holdgraf
@@ -26,3 +26,4 @@ dependencies:
|
||||
- alabaster_jupyterhub
|
||||
- autodoc-traits
|
||||
- sphinx-jsonschema
|
||||
- -r requirements.txt
|
||||
@@ -7,3 +7,4 @@ recommonmark==0.5.0
|
||||
sphinx-copybutton
|
||||
sphinx-jsonschema
|
||||
sphinx>=1.7
|
||||
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
|
||||
|
||||
@@ -74,10 +74,7 @@ source_suffix = ['.rst', '.md']
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages.
|
||||
import alabaster_jupyterhub
|
||||
|
||||
html_theme = 'alabaster_jupyterhub'
|
||||
html_theme_path = [alabaster_jupyterhub.get_html_theme_path()]
|
||||
html_theme = 'pandas_sphinx_theme'
|
||||
|
||||
html_logo = '_static/images/logo/logo.png'
|
||||
html_favicon = '_static/images/logo/favicon.ico'
|
||||
@@ -85,31 +82,6 @@ html_favicon = '_static/images/logo/favicon.ico'
|
||||
# Paths that contain custom static files (such as style sheets)
|
||||
html_static_path = ['_static']
|
||||
|
||||
html_theme_options = {
|
||||
'show_related': True,
|
||||
'description': 'Documentation for JupyterHub',
|
||||
'github_user': 'jupyterhub',
|
||||
'github_repo': 'jupyterhub',
|
||||
'github_banner': False,
|
||||
'github_button': True,
|
||||
'github_type': 'star',
|
||||
'show_powered_by': False,
|
||||
'extra_nav_links': {
|
||||
'GitHub Repo': 'http://github.com/jupyterhub/jupyterhub',
|
||||
'Issue Tracker': 'http://github.com/jupyterhub/jupyterhub/issues',
|
||||
},
|
||||
}
|
||||
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'about.html',
|
||||
'searchbox.html',
|
||||
'navigation.html',
|
||||
'relations.html',
|
||||
'sourcelink.html',
|
||||
]
|
||||
}
|
||||
|
||||
htmlhelp_basename = 'JupyterHubdoc'
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
21
docs/source/contributing/index.rst
Normal file
21
docs/source/contributing/index.rst
Normal file
@@ -0,0 +1,21 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
|
||||
We want you to contribute to JupyterHub in ways that are most exciting
|
||||
& useful to you. We value documentation, testing, bug reporting & code equally,
|
||||
and are glad to have your contributions in whatever form you wish :)
|
||||
|
||||
Our `Code of Conduct <https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md>`_
|
||||
(`reporting guidelines <https://github.com/jupyter/governance/blob/master/conduct/reporting_online.md>`_)
|
||||
helps keep our community welcoming to as many people as possible.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributing/community
|
||||
contributing/setup
|
||||
contributing/docs
|
||||
contributing/tests
|
||||
contributing/roadmap
|
||||
contributing/security
|
||||
@@ -10,3 +10,4 @@ Getting Started
|
||||
authenticators-users-basics
|
||||
spawners-basics
|
||||
services-basics
|
||||
institutional-faq
|
||||
11
docs/source/index-about.rst
Normal file
11
docs/source/index-about.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
================
|
||||
About JupyterHub
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
index-about
|
||||
contributor-list
|
||||
changelog
|
||||
gallery-jhub-deployments
|
||||
11
docs/source/index-installation.rst
Normal file
11
docs/source/index-installation.rst
Normal file
@@ -0,0 +1,11 @@
|
||||
==================
|
||||
Installation guide
|
||||
==================
|
||||
|
||||
.. troctree::
|
||||
:maxdepth: 2
|
||||
|
||||
installation-guide
|
||||
quickstart
|
||||
quickstart-docker
|
||||
installation-basics
|
||||
@@ -2,18 +2,18 @@
|
||||
JupyterHub
|
||||
==========
|
||||
|
||||
`JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users.
|
||||
It can be used in a classes of students, a corporate data science group or scientific
|
||||
`JupyterHub`_ is the best way to serve `Jupyter notebook`_ for multiple users.
|
||||
It can be used in a classes of students, a corporate data science group or scientific
|
||||
research group. It is a multi-user **Hub** that spawns, manages, and proxies multiple
|
||||
instances of the single-user `Jupyter notebook`_ server.
|
||||
|
||||
To make life easier, JupyterHub have distributions. Be sure to
|
||||
take a look at them before continuing with the configuration of the broad
|
||||
original system of `JupyterHub`_. Today, you can find two main cases:
|
||||
To make life easier, JupyterHub have distributions. Be sure to
|
||||
take a look at them before continuing with the configuration of the broad
|
||||
original system of `JupyterHub`_. Today, you can find two main cases:
|
||||
|
||||
1. If you need a simple case for a small amount of users (0-100) and single server
|
||||
take a look at
|
||||
`The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution.
|
||||
1. If you need a simple case for a small amount of users (0-100) and single server
|
||||
take a look at
|
||||
`The Littlest JupyterHub <https://github.com/jupyterhub/the-littlest-jupyterhub>`__ distribution.
|
||||
2. If you need to allow for even more users, a dynamic amount of servers can be used on a cloud,
|
||||
take a look at the `Zero to JupyterHub with Kubernetes <https://github.com/jupyterhub/zero-to-jupyterhub-k8s>`__ .
|
||||
|
||||
@@ -74,10 +74,7 @@ Installation Guide
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
installation-guide
|
||||
quickstart
|
||||
quickstart-docker
|
||||
installation-basics
|
||||
index-installation
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
@@ -86,13 +83,6 @@ Getting Started
|
||||
:maxdepth: 1
|
||||
|
||||
getting-started/index
|
||||
getting-started/institutional-faq
|
||||
getting-started/config-basics
|
||||
getting-started/networking-basics
|
||||
getting-started/security-basics
|
||||
getting-started/authenticators-users-basics
|
||||
getting-started/spawners-basics
|
||||
getting-started/services-basics
|
||||
|
||||
Technical Reference
|
||||
-------------------
|
||||
@@ -101,18 +91,6 @@ Technical Reference
|
||||
:maxdepth: 1
|
||||
|
||||
reference/index
|
||||
reference/technical-overview
|
||||
reference/websecurity
|
||||
reference/authenticators
|
||||
reference/spawners
|
||||
reference/services
|
||||
reference/rest
|
||||
reference/templates
|
||||
reference/config-user-env
|
||||
reference/config-examples
|
||||
reference/config-ghoauth
|
||||
reference/config-proxy
|
||||
reference/config-sudo
|
||||
|
||||
Contributing
|
||||
------------
|
||||
@@ -126,31 +104,25 @@ Our `Code of Conduct <https://github.com/jupyter/governance/blob/master/conduct/
|
||||
helps keep our community welcoming to as many people as possible.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
|
||||
contributing/community
|
||||
contributing/setup
|
||||
contributing/docs
|
||||
contributing/tests
|
||||
contributing/roadmap
|
||||
contributing/security
|
||||
contributing/index
|
||||
|
||||
Eventlogging and Telemetry
|
||||
--------------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
:maxdepth: 2
|
||||
|
||||
events/index
|
||||
|
||||
Upgrading JupyterHub
|
||||
Administrators guide
|
||||
--------------------
|
||||
|
||||
We try to make upgrades between minor versions as painless as possible.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
troubleshooting
|
||||
admin/upgrading
|
||||
changelog
|
||||
|
||||
@@ -162,23 +134,13 @@ API Reference
|
||||
|
||||
api/index
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
troubleshooting
|
||||
|
||||
About JupyterHub
|
||||
----------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
contributor-list
|
||||
changelog
|
||||
gallery-jhub-deployments
|
||||
index-about
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
@@ -193,24 +155,6 @@ Questions? Suggestions?
|
||||
- `Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>`_
|
||||
- `Jupyter website <https://jupyter.org>`_
|
||||
|
||||
.. _contents:
|
||||
|
||||
Full Table of Contents
|
||||
======================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
installation-guide
|
||||
getting-started/index
|
||||
reference/index
|
||||
api/index
|
||||
troubleshooting
|
||||
contributor-list
|
||||
gallery-jhub-deployments
|
||||
changelog
|
||||
|
||||
|
||||
.. _JupyterHub: https://github.com/jupyterhub/jupyterhub
|
||||
.. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/
|
||||
.. _REST API: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#!/default
|
||||
|
||||
Reference in New Issue
Block a user