updating to pandas docs theme

This commit is contained in:
Chris Holdgraf
2019-11-14 18:45:48 -08:00
parent 5ee2994504
commit c8e4d68978
8 changed files with 63 additions and 101 deletions

View File

@@ -26,3 +26,4 @@ dependencies:
- alabaster_jupyterhub - alabaster_jupyterhub
- autodoc-traits - autodoc-traits
- sphinx-jsonschema - sphinx-jsonschema
- -r requirements.txt

View File

@@ -7,3 +7,4 @@ recommonmark==0.5.0
sphinx-copybutton sphinx-copybutton
sphinx-jsonschema sphinx-jsonschema
sphinx>=1.7 sphinx>=1.7
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master

View File

@@ -74,10 +74,7 @@ source_suffix = ['.rst', '.md']
# -- Options for HTML output ---------------------------------------------- # -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. # The theme to use for HTML and HTML Help pages.
import alabaster_jupyterhub html_theme = 'pandas_sphinx_theme'
html_theme = 'alabaster_jupyterhub'
html_theme_path = [alabaster_jupyterhub.get_html_theme_path()]
html_logo = '_static/images/logo/logo.png' html_logo = '_static/images/logo/logo.png'
html_favicon = '_static/images/logo/favicon.ico' 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) # Paths that contain custom static files (such as style sheets)
html_static_path = ['_static'] 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' htmlhelp_basename = 'JupyterHubdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------

View 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

View File

@@ -10,3 +10,4 @@ Getting Started
authenticators-users-basics authenticators-users-basics
spawners-basics spawners-basics
services-basics services-basics
institutional-faq

View File

@@ -0,0 +1,11 @@
================
About JupyterHub
================
.. toctree::
:maxdepth: 1
index-about
contributor-list
changelog
gallery-jhub-deployments

View File

@@ -0,0 +1,11 @@
==================
Installation guide
==================
.. troctree::
:maxdepth: 2
installation-guide
quickstart
quickstart-docker
installation-basics

View File

@@ -74,10 +74,7 @@ Installation Guide
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
installation-guide index-installation
quickstart
quickstart-docker
installation-basics
Getting Started Getting Started
--------------- ---------------
@@ -86,13 +83,6 @@ Getting Started
:maxdepth: 1 :maxdepth: 1
getting-started/index 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 Technical Reference
------------------- -------------------
@@ -101,18 +91,6 @@ Technical Reference
:maxdepth: 1 :maxdepth: 1
reference/index 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 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. helps keep our community welcoming to as many people as possible.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
contributing/community contributing/index
contributing/setup
contributing/docs
contributing/tests
contributing/roadmap
contributing/security
Eventlogging and Telemetry Eventlogging and Telemetry
-------------------------- --------------------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 2
events/index events/index
Upgrading JupyterHub Administrators guide
-------------------- --------------------
We try to make upgrades between minor versions as painless as possible.
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
troubleshooting
admin/upgrading admin/upgrading
changelog changelog
@@ -162,23 +134,13 @@ API Reference
api/index api/index
Troubleshooting
---------------
.. toctree::
:maxdepth: 1
troubleshooting
About JupyterHub About JupyterHub
---------------- ----------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
contributor-list index-about
changelog
gallery-jhub-deployments
Indices and tables Indices and tables
================== ==================
@@ -193,24 +155,6 @@ Questions? Suggestions?
- `Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>`_ - `Jupyter mailing list <https://groups.google.com/forum/#!forum/jupyter>`_
- `Jupyter website <https://jupyter.org>`_ - `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 .. _JupyterHub: https://github.com/jupyterhub/jupyterhub
.. _Jupyter notebook: https://jupyter-notebook.readthedocs.io/en/latest/ .. _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 .. _REST API: http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml#!/default