Merge pull request #468 from yuvipanda/pandas-theme

Switch to pandas theme

docs/conf.py

@@ -34,10 +34,7 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
-import alabaster_jupyterhub
-
-html_theme = 'alabaster_jupyterhub'
-html_theme_path = [alabaster_jupyterhub.get_html_theme_path()]
+html_theme = 'pandas_sphinx_theme'
 
 html_logo = 'images/logo/logo.png'
 html_favicon = 'images/logo/favicon.ico'
@@ -62,19 +59,3 @@
         'donate.html',
     ]
 }
-# Custom Alabaster theme options
-html_theme_options = {
-    '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>
-    """,
-    'github_user': 'jupyterhub',
-    'github_repo': 'the-littlest-jupyterhub',
-    'github_button': True,
-    'github_banner': False,
-    'github_type': 'star',
-}
-
-def setup(app):
-    app.add_stylesheet('custom.css')

docs/contributing/index.rst

@@ -0,0 +1,17 @@
+============
+Contributing
+============
+
+We want you to contribute to TLJH in the ways that are most useful
+and exciting to you. This section contains documentation helpful
+to people contributing in various ways.
+
+.. toctree::
+   :titlesonly:
+
+   docs
+   code-review
+   dev-setup
+   tests
+   plugins
+   packages

docs/howto/index.rst

@@ -0,0 +1,62 @@
+How-To Guides
+=============
+
+How-To guides answer the question 'How do I...?' for a lot of topics.
+
+Content and Data
+----------------
+
+.. toctree::
+   :titlesonly:
+
+   content/nbgitpuller
+   content/add-data
+   content/share-data
+
+The user environment
+--------------------
+
+.. toctree::
+   :titlesonly:
+
+   env/user-environment
+   env/notebook-interfaces
+   env/server-resources
+
+Authentication
+--------------
+
+We have a special set of How-To Guides on using various forms of authentication
+with your JupyterHub. For more information on Authentication, see
+:ref:`topic/authenticator-configuration`
+
+.. toctree::
+   :titlesonly:
+
+   auth/dummy
+   auth/github
+   auth/google
+   auth/firstuse
+   auth/nativeauth
+
+Administration and security
+---------------------------
+
+.. toctree::
+   :titlesonly:
+
+   admin/admin-users
+   admin/resource-estimation
+   admin/resize
+   admin/nbresuse
+   admin/https
+   admin/enable-extensions
+
+Cloud provider configuration
+----------------------------
+
+.. toctree::
+   :titlesonly:
+
+   providers/digitalocean
+   providers/azure

docs/index.rst

@@ -27,15 +27,9 @@ We have a bunch of tutorials to get you started.
 
   .. toctree::
      :titlesonly:
-     :caption: Installation
+     :maxdepth: 2
 
-     install/digitalocean
-     install/ovh
-     install/jetstream
-     install/google
-     install/amazon
-     install/azure
-     install/custom-server
+     install/index
 
 Once you are ready to run your server for real,
 it's a good idea to proceed directly to :doc:`howto/admin/https`.
@@ -45,68 +39,10 @@ How-To Guides
 
 How-To guides answer the question 'How do I...?' for a lot of topics.
 
-Content and Data
-----------------
-
-.. toctree::
-   :titlesonly:
-   :caption: Content and data
-
-   howto/content/nbgitpuller
-   howto/content/add-data
-   howto/content/share-data
-
-The user environment
---------------------
-
 .. toctree::
-   :titlesonly:
-   :caption: The user environment
-
-   howto/env/user-environment
-   howto/env/notebook-interfaces
-   howto/env/server-resources
+   :maxdepth: 2
 
-Authentication
---------------
-
-We have a special set of How-To Guides on using various forms of authentication
-with your JupyterHub. For more information on Authentication, see
-:ref:`topic/authenticator-configuration`
-
-.. toctree::
-   :titlesonly:
-   :caption: Authentication
-
-   howto/auth/dummy
-   howto/auth/github
-   howto/auth/google
-   howto/auth/firstuse
-   howto/auth/nativeauth
-
-Administration and security
----------------------------
-
-.. toctree::
-   :titlesonly:
-   :caption: Administration and security
-
-   howto/admin/admin-users
-   howto/admin/resource-estimation
-   howto/admin/resize
-   howto/admin/nbresuse
-   howto/admin/https
-   howto/admin/enable-extensions
-
-Cloud provider configuration
-----------------------------
-
-.. toctree::
-   :titlesonly:
-   :caption: Cloud provider configuration
-
-   howto/providers/digitalocean
-   howto/providers/azure
+   howto/index
 
 Topic Guides
 ============
@@ -115,17 +51,9 @@ Topic guides provide in-depth explanations of specific topics.
 
 .. toctree::
    :titlesonly:
-   :caption: Topic guides
+   :maxdepth: 2
 
-   topic/whentouse
-   topic/requirements
-   topic/security
-   topic/customizing-installer
-   topic/installer-actions
-   topic/tljh-config
-   topic/authenticator-configuration
-   topic/escape-hatch
-   topic/idle-culler
+   topic/index
 
 
 Troubleshooting
@@ -136,21 +64,9 @@ guides help you find what is broken & hopefully fix it.
 
 .. toctree::
    :titlesonly:
-   :caption: Troubleshooting
-
-   troubleshooting/logs
+   :maxdepth: 2
 
-Often, your issues are not related to TLJH itself but to the cloud provider
-your server is running on. We have some documentation on common issues you
-might run into with various providers and how to fix them. We welcome contributions
-here to better support your favorite provider!
-
-.. toctree::
-   :titlesonly:
-
-   troubleshooting/providers/google
-   troubleshooting/providers/amazon
-   troubleshooting/providers/custom
+   troubleshooting/index
 
 Contributing
 ============
@@ -161,11 +77,6 @@ to people contributing in various ways.
 
 .. toctree::
    :titlesonly:
-   :caption: Contributing
-
-   contributing/docs
-   contributing/code-review
-   contributing/dev-setup
-   contributing/tests
-   contributing/plugins
-   contributing/packages
+   :maxdepth: 2
+
+   contributing/index

docs/install/index.rst

@@ -0,0 +1,22 @@
+==========
+Installing
+==========
+
+The Littlest JupyterHub (TLJH) can run on any server that is running at least
+**Ubuntu 18.04**. Earlier versions of Ubuntu are not supported.
+We have a bunch of tutorials to get you started.
+
+Tutorials to create a new server from scratch on a cloud provider & run TLJH
+on it. These are **recommended** if you do not have much experience setting up
+servers.
+
+  .. toctree::
+     :titlesonly:
+
+     digitalocean
+     ovh
+     jetstream
+     google
+     amazon
+     azure
+     custom-server

docs/requirements.txt

@@ -1,4 +1,3 @@
 sphinx>=1.4, !=1.5.4
 sphinx_copybutton
-alabaster
-alabaster_jupyterhub
+git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master

docs/topic/index.rst

@@ -0,0 +1,19 @@
+============
+Topic Guides
+============
+
+Topic guides provide in-depth explanations of specific topics.
+
+.. toctree::
+   :titlesonly:
+   :caption: Topic guides
+
+   whentouse
+   requirements
+   security
+   customizing-installer
+   installer-actions
+   tljh-config
+   authenticator-configuration
+   escape-hatch
+   idle-culler

docs/troubleshooting/index.rst

@@ -0,0 +1,24 @@
+===============
+Troubleshooting
+===============
+
+In time, all systems have issues that need to be debugged. Troubleshooting
+guides help you find what is broken & hopefully fix it.
+
+.. toctree::
+   :titlesonly:
+   :caption: Troubleshooting
+
+   logs
+
+Often, your issues are not related to TLJH itself but to the cloud provider
+your server is running on. We have some documentation on common issues you
+might run into with various providers and how to fix them. We welcome contributions
+here to better support your favorite provider!
+
+.. toctree::
+   :titlesonly:
+
+   providers/google
+   providers/amazon
+   providers/custom