converting to pandas theme and some reorganization for clarity

ltammariello · Nov 9, 2019 · 1b4cbf3 · 1b4cbf3
1 parent d06f7b8
commit 1b4cbf3
Show file tree

Hide file tree

Showing 44 changed files with 55 additions and 55 deletions.
diff --git a/.gitignore b/.gitignore
@@ -114,7 +114,7 @@ instance/
 
 # Sphinx documentation
 doc/build/
-doc/source/reference.md
+doc/source/reference/reference.md
 
 # PyBuilder
 target/

diff --git a/doc/doc-requirements.txt b/doc/doc-requirements.txt
@@ -2,4 +2,4 @@ sphinx>=1.7
 recommonmark==0.4.0
 pyyaml
 sphinx-copybutton
-alabaster_jupyterhub
+git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master
diff --git a/doc/environment.yml b/doc/environment.yml
@@ -8,4 +8,4 @@ dependencies:
     - recommonmark==0.4.0
     - pyyaml
     - sphinx-copybutton
-    - alabaster_jupyterhub
+    - r doc-requirements.txt
diff --git a/doc/source/_static/images/logo/logo.png b/doc/source/_static/images/logo/logo.png
diff --git a/doc/source/advanced.md → doc/source/administrator/advanced.md b/doc/source/advanced.md → doc/source/administrator/advanced.md
diff --git a/doc/source/architecture.rst → doc/source/administrator/architecture.rst b/doc/source/architecture.rst → doc/source/administrator/architecture.rst
diff --git a/doc/source/authentication.rst → doc/source/administrator/authentication.rst b/doc/source/authentication.rst → doc/source/administrator/authentication.rst
diff --git a/doc/source/cost.rst → doc/source/administrator/cost.rst b/doc/source/cost.rst → doc/source/administrator/cost.rst
diff --git a/doc/source/debug.rst → doc/source/administrator/debug.rst b/doc/source/debug.rst → doc/source/administrator/debug.rst
diff --git a/doc/source/index-administrator-guide.rst → doc/source/administrator/index.rst b/doc/source/index-administrator-guide.rst → doc/source/administrator/index.rst
diff --git a/doc/source/optimization.md → doc/source/administrator/optimization.md b/doc/source/optimization.md → doc/source/administrator/optimization.md
diff --git a/doc/source/security.md → doc/source/administrator/security.md b/doc/source/security.md → doc/source/administrator/security.md
diff --git a/doc/source/troubleshooting.rst → doc/source/administrator/troubleshooting.rst b/doc/source/troubleshooting.rst → doc/source/administrator/troubleshooting.rst
diff --git a/doc/source/upgrading.md → doc/source/administrator/upgrading.md b/doc/source/upgrading.md → doc/source/administrator/upgrading.md
diff --git a/doc/source/amazon/step-zero-aws-eks.rst b/doc/source/amazon/step-zero-aws-eks.rst
@@ -1,7 +1,7 @@
 .. _amazon-aws-eks:
 
-Step Zero: Kubernetes on Amazon Web Services (AWS) with Elastic Container with Kubernetes (EKS)
------------------------------------------------------------------------------------------------
+Kubernetes on Amazon Web Services (AWS) with Elastic Container with Kubernetes (EKS)
+------------------------------------------------------------------------------------
 
 AWS has released native support for Kubernetes, which is available in `selected regions`_.
 
@@ -18,21 +18,21 @@ Procedure
    * AmazonEKSClusterPolicy
    * AmazonEKSServicePolicy
    * AmazonEC2ContainerRegistryReadOnly
-   
-   (From the user interface, select EKS as the service, then follow the default steps) 
-   
+
+   (From the user interface, select EKS as the service, then follow the default steps)
+
 2. Create a VPC if you don't already have one.
 
     This step has a lot of variability so it is left to the user. However, one deployment can be found at `Getting Started with Amazon EKS`_, under *Create your Amazon EKS Cluster VPC*
-   
+
 3. Create a Security Group for the EKS Control Plane to use
-    
+
     You do not need to set any permissions on this. The steps below will automatically define access control between the EKS Control Plane and the individual nodes
 
 4. Create your EKS cluster (using the user interface)
- 
+
     Use the IAM Role in step 1 and Security Group defined in step 3. The cluster name is going to be used throughout. We'll use ``Z2JHKubernetesCluster`` as an example.
-    
+
 5. Install **kubectl** and **aws-iam-authenticator**
 
     Refer to  `Getting Started with Amazon EKS`_ on *Configure kubectl for Amazon EKS*
@@ -42,7 +42,7 @@ Procedure
    Also see `Getting Started with Amazon EKS`_ *Step 2: Configure kubectl for Amazon EKS*
 
    From the user interface on AWS you can retrieve the ``endpoint-url``, ``base64-encoded-ca-cert``. ``cluster-name`` is the name given in step 4. If you are using profiles in your AWS configuration, you can uncomment the ``env`` block and specify your profile as ``aws-profile``.::
-    
+
      apiVersion: v1
      clusters:
      - cluster:
@@ -76,20 +76,20 @@ Procedure
 
    .. code-block:: bash
 
-        kubectl get svc    
+        kubectl get svc
 
    should return ``kubernetes`` and ``ClusterIP``
-    
+
 8. Create the nodes using CloudFormation
 
     See `Getting Started with Amazon EKS`_ *Step 3: Launch and Configure Amazon EKS Worker Nodes*
 
     **Warning** if you are endeavoring to deploy on a private network, the cloudformation template creates a public IP for each worker node though there is no route to get there if you specified only private subnets. Regardless, if you wish to correct this, you can edit the cloudformation template by changing ``Resources.NodeLaunchConfig.Properties.AssociatePublicIpAddress`` from ``'true'`` to ``'false'``
-    
+
 9. Create a AWS authentication ConfigMap
 
     This is necessary for the workers to find the master plane.
-  
+
     See `Getting Started with Amazon EKS`_ *Step 3: Launch and Configure Amazon EKS Worker Nodes*
 
 10. Preparing authenticator for Helm

diff --git a/doc/source/amazon/step-zero-aws.rst b/doc/source/amazon/step-zero-aws.rst
@@ -1,7 +1,7 @@
 .. _amazon-aws:
 
-Step Zero: Kubernetes on Amazon Web Services (AWS)
---------------------------------------------------
+Kubernetes on Amazon Web Services (AWS)
+---------------------------------------
 
 AWS does not have native support for Kubernetes, however there are
 many organizations that have put together their own solutions and

diff --git a/doc/source/additional-resources.rst → ...source/community/additional-resources.rst b/doc/source/additional-resources.rst → ...source/community/additional-resources.rst
diff --git a/doc/source/index-community-resources.rst → doc/source/community/index.rst b/doc/source/index-community-resources.rst → doc/source/community/index.rst
@@ -1,6 +1,6 @@
-============================
-Resources from the community
-============================
+===================
+Community Resources
+===================
 
 This section gives the community a space to provide information on setting
 up, managing, and maintaining JupyterHub.
@@ -18,7 +18,7 @@ up, managing, and maintaining JupyterHub.
 
 We hope that you will use this section to share deployments with on a variety
 of infrastructure and for different use cases.
-There is also a :doc:`community maintained list <users-list>` of users of this
+There is also a :doc:`community maintained list <community/users-list>` of users of this
 Guide and the JupyterHub Helm Chart.
 
 Please submit a pull request to add to this section. Thanks.

diff --git a/doc/source/tips.rst → doc/source/community/tips.rst b/doc/source/tips.rst → doc/source/community/tips.rst
diff --git a/doc/source/users-list.md → doc/source/community/users-list.md b/doc/source/users-list.md → doc/source/community/users-list.md
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -225,13 +225,13 @@ def parse_yaml(yaml, count=0, pre=''):
 parse_yaml(data)
 
 # Generate the `.md` file
-with open('reference.txt', 'r') as f:
+with open('reference/reference.txt', 'r') as f:
     new_lines = f.readlines()
     new_lines = new_lines[1:]
     new_lines = [ln.strip('\n') for ln in new_lines]
 new_lines += lines
 
-with open('reference.md', 'w') as f:
+with open('reference/reference.md', 'w') as f:
     f.write('\n'.join(new_lines))
 
 

diff --git a/doc/source/create-k8s-cluster.rst b/doc/source/create-k8s-cluster.rst
@@ -1,7 +1,7 @@
 .. _create-k8s-cluster:
 
-Setup a Kubernetes Cluster
-==========================
+Setup Kubernetes
+================
 
 Kubernetes' documentation describes the many `ways to set up a cluster`_.
 We attempt to provide quick instructions for the most painless and popular ways of setting up

diff --git a/doc/source/extending-jupyterhub.rst → ...urce/customizing/extending-jupyterhub.rst b/doc/source/extending-jupyterhub.rst → ...urce/customizing/extending-jupyterhub.rst
diff --git a/doc/source/index-customization-guide.rst → doc/source/customizing/index.rst b/doc/source/index-customization-guide.rst → doc/source/customizing/index.rst
diff --git a/doc/source/user-environment.rst → doc/source/customizing/user-environment.rst b/doc/source/user-environment.rst → doc/source/customizing/user-environment.rst
diff --git a/doc/source/user-management.md → doc/source/customizing/user-management.md b/doc/source/user-management.md → doc/source/customizing/user-management.md
diff --git a/doc/source/user-resources.rst → doc/source/customizing/user-resources.rst b/doc/source/user-resources.rst → doc/source/customizing/user-resources.rst
diff --git a/doc/source/user-storage.md → doc/source/customizing/user-storage.md b/doc/source/user-storage.md → doc/source/customizing/user-storage.md
diff --git a/doc/source/digital-ocean/step-zero-digital-ocean.rst b/doc/source/digital-ocean/step-zero-digital-ocean.rst
@@ -1,7 +1,7 @@
 .. _digital-ocean:
 
-Step Zero: Kubernetes on Digital Ocean
---------------------------------------
+Kubernetes on Digital Ocean
+---------------------------
 
 You can create a Kubernetes cluster `either through the Digital Ocean website, or using the Digital Ocean command line tools <https://www.digitalocean.com/>`_.
 
@@ -10,8 +10,8 @@ If you prefer to use the Digital Ocean portal see the `Digital Ocean Get Started
 
 
 #. Prepare your Digital Ocean shell environment.
-   
-   a. **Install command-line tools locally**. You'll need at least v1.13.0. 
+
+   a. **Install command-line tools locally**. You'll need at least v1.13.0.
 
      You can either follow the `installation instructions <https://github.com/digitalocean/doctl/blob/master/README.md>` or use the commands below:
 

diff --git a/doc/source/google/step-zero-gcp.rst b/doc/source/google/step-zero-gcp.rst
@@ -1,7 +1,7 @@
 .. _google-cloud:
 
-Step Zero: Kubernetes on `Google Cloud <https://cloud.google.com/>`_ (GKE)
---------------------------------------------------------------------------
+Kubernetes on `Google Cloud <https://cloud.google.com/>`_ (GKE)
+---------------------------------------------------------------
 
 `Google Kubernetes Engine <https://cloud.google.com/kubernetes-engine/>`_
 (GKE) is the simplest and most common way of setting

diff --git a/doc/source/ibm/step-zero-ibm.rst b/doc/source/ibm/step-zero-ibm.rst
@@ -1,16 +1,16 @@
 .. _ibm_cloud:
 
-Step Zero: Kubernetes on IBM Cloud
-----------------------------------
+Kubernetes on IBM Cloud
+-----------------------
 
-This guide shows how to deploy JupyterHub on the IBM Cloud using their `Kubernetes service <https://console.bluemix.net/containers-kubernetes/catalog/cluster)>`_. 
+This guide shows how to deploy JupyterHub on the IBM Cloud using their `Kubernetes service <https://console.bluemix.net/containers-kubernetes/catalog/cluster)>`_.
 It should provide you with enough knowledge to create a cluster, deploy your application using a Docker image and use a custom domain to use the deployed app.
 
 Before you begin:
 
-* Understand the basics of Kubernetes_. 
+* Understand the basics of Kubernetes_.
     .. _Kubernetes: https://kubernetes.io/docs/tutorials/kubernetes-basics/)
-* Install the IBM Cloud Developer Tools 
+* Install the IBM Cloud Developer Tools
     - Install the `IBM Cloud CLI <https://console.bluemix.net/docs/cli/index.html#overview)>`_.
     - `curl -sL https://ibm.biz/idt-installer | bash`
     - Verify your installation
@@ -41,13 +41,13 @@ Procedure:
 
         .. image:: ../_static/images/ibm/create-paid-kubernetes-cluster-ibm-cloud.png
             :align: center
-   
+
      3. Check the status of your **Cluster** and **Worker Nodes** and wait for them to be **ready**.
 
      Or, if you prefer, create the cluster using the `IBM Cloud CLI tools <https://console.bluemix.net/docs/containers/cs_clusters.html#clusters_cli)>`_
 
 2. Configure kubectl
-   
+
    `kubectl <https://kubernetes.io/docs/user-guide/kubectl-overview/)>`_ is a CLI tool to interact with a Kubernetes cluster. In this occasion, you will use it to point forward to the created Kubernetes cluster.
 
    1. Use `ibmcloud login` to log in interactively into the IBM Cloud. Provide the organization (org), location and space under which the cluster is created. You can reconfirm the details by running `ibmcloud target` command.
@@ -60,7 +60,7 @@ Procedure:
         .. code-block:: bash
 
            export KUBECONFIG=/Users/user/.bluemix/plugins/container-service/clusters/JupyterHub/kube-config-***-JupyterHub.yml
-   
+
         To verify whether the KUBECONFIG environment variable is set correctly or not, run the following command:
             .. code-block:: bash
 
@@ -70,7 +70,7 @@ Procedure:
         .. code-block:: bash
 
            kubectl cluster-info
-        
+
 
         .. image:: ../_static/images/ibm/kubectl-cluster-info.png
          :align: center
@@ -80,4 +80,4 @@ Hooray! You have your Kubernetes cluster running; it's time to begin :ref:`creat
 
 More info and readings:
     - https://console.bluemix.net/docs/tutorials/scalable-webapp-kubernetes.html#deploy-a-scalable-web-application-on-kubernetes
-    - https://github.com/IBM-Cloud/get-started-python 
+    - https://github.com/IBM-Cloud/get-started-python
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -76,7 +76,7 @@ an initial deployment.
    :maxdepth: 1
    :caption: Setup JupyterHub
 
-   index-setup-jupyterhub
+   setup-jupyterhub/index
 
 .. _customization-guide:
 
@@ -94,7 +94,7 @@ used configurable helm chart fields.
    :maxdepth: 2
    :caption: Customization Guide
 
-   index-customization-guide
+   customizing/index
 
 .. _administrator-guide:
 
@@ -109,7 +109,7 @@ cloud-based deployments and tips for maintaining your deployment.
    :maxdepth: 2
    :caption: Administrator Guide
 
-   index-administrator-guide
+   administrator/index
 
 .. _community-resources:
 
@@ -132,7 +132,7 @@ up, managing, and maintaining JupyterHub.
 
 We hope that you will use this section to share deployments with on a variety
 of infrastructure and for different use cases.
-There is also a :doc:`community maintained list <users-list>` of users of this
+There is also a :doc:`community maintained list <community/users-list>` of users of this
 Guide and the JupyterHub Helm Chart.
 
 Please submit a pull request to add to this section. Thanks.
@@ -141,7 +141,7 @@ Please submit a pull request to add to this section. Thanks.
    :maxdepth: 1
    :caption: Community section
 
-   index-community-resources
+   community/index
 
 .. _reference:
 
@@ -152,7 +152,7 @@ Reference
    :maxdepth: 1
    :caption: Reference
 
-   index-reference
+   reference/index
 
 Institutional support
 ---------------------

diff --git a/doc/source/microsoft/step-zero-azure-autoscale.rst b/doc/source/microsoft/step-zero-azure-autoscale.rst
@@ -1,7 +1,7 @@
 .. _microsoft-azure:
 
-Step Zero: Kubernetes on Microsoft Azure Kubernetes Service (AKS) with Autoscaling
-----------------------------------------------------------------------------------
+Kubernetes on Microsoft Azure Kubernetes Service (AKS) with Autoscaling
+-----------------------------------------------------------------------
 
 .. warning::
 

diff --git a/doc/source/microsoft/step-zero-azure.rst b/doc/source/microsoft/step-zero-azure.rst
@@ -1,7 +1,7 @@
 .. _microsoft-azure:
 
-Step Zero: Kubernetes on Microsoft Azure Kubernetes Service (AKS)
------------------------------------------------------------------
+Kubernetes on Microsoft Azure Kubernetes Service (AKS)
+------------------------------------------------------
 
 You can create a Kubernetes cluster `either through the Azure portal website, or using the Azure command line tools <https://docs.microsoft.com/en-us/azure/aks/>`_.
 

diff --git a/doc/source/redhat/step-zero-openshift.rst b/doc/source/redhat/step-zero-openshift.rst
@@ -1,7 +1,7 @@
 .. _redhat-openshift:
 
-Step Zero: Kubernetes on Red Hat OpenShift
-------------------------------------------
+Kubernetes on Red Hat OpenShift
+-------------------------------
 
 `OpenShift <https://www.okd.io/>`_ from RedHat is a cluster manager based on Kubernetes.
 

diff --git a/doc/source/glossary.rst → doc/source/reference/glossary.rst b/doc/source/glossary.rst → doc/source/reference/glossary.rst
diff --git a/doc/source/index-reference.rst → doc/source/reference/index.rst b/doc/source/index-reference.rst → doc/source/reference/index.rst
diff --git a/doc/source/reference-docs.rst → doc/source/reference/reference-docs.rst b/doc/source/reference-docs.rst → doc/source/reference/reference-docs.rst
diff --git a/doc/source/reference.txt → doc/source/reference/reference.txt b/doc/source/reference.txt → doc/source/reference/reference.txt
diff --git a/doc/source/tools.rst → doc/source/reference/tools.rst b/doc/source/tools.rst → doc/source/reference/tools.rst
diff --git a/doc/source/index-setup-jupyterhub.rst → doc/source/setup-jupyterhub/index.rst b/doc/source/index-setup-jupyterhub.rst → doc/source/setup-jupyterhub/index.rst
diff --git a/doc/source/setup-helm.rst → doc/source/setup-jupyterhub/setup-helm.rst b/doc/source/setup-helm.rst → doc/source/setup-jupyterhub/setup-helm.rst
diff --git a/doc/source/setup-jupyterhub.rst → ...rce/setup-jupyterhub/setup-jupyterhub.rst b/doc/source/setup-jupyterhub.rst → ...rce/setup-jupyterhub/setup-jupyterhub.rst
diff --git a/doc/source/turn-off.rst → doc/source/setup-jupyterhub/turn-off.rst b/doc/source/turn-off.rst → doc/source/setup-jupyterhub/turn-off.rst