Skip to content

Commit

Permalink
Merge pull request #1608 from choldgraf/pydata
Browse files Browse the repository at this point in the history
pydata theme
  • Loading branch information
consideRatio committed Mar 24, 2020
2 parents a5127ae + 422c516 commit 4c5dc3d
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 22 deletions.
4 changes: 2 additions & 2 deletions doc/doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sphinx>=1.7
recommonmark==0.4.0
recommonmark
pyyaml
sphinx-copybutton
https://github.com/pandas-dev/pandas-sphinx-theme/archive/ade576c92cfe46a372b6783fb83f45c44fc67976.zip
pydata_sphinx_theme
29 changes: 19 additions & 10 deletions doc/source/amazon/step-zero-aws.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,31 +43,36 @@ The Procedure
Since we are not using pre-configured DNS we will use the suffix ".k8s.local". Per the docs, if the DNS name ends in .k8s.local the cluster will use internal hosted DNS.

.. code-block:: bash
export NAME=<somename>.k8s.local
export NAME=<somename>.k8s.local
#. Setup an ssh keypair to use with the cluster

.. code-block:: bash
ssh-keygen
ssh-keygen
#. Create a S3 bucket to store your cluster configuration

Since we are on AWS we can use a S3 backing store. It is recommended to enabling versioning on the S3 bucket.
We don't need to pass this into the KOPS commands. It is automatically detected by the kops tool as an env variable.

.. code-block:: bash
export KOPS_STATE_STORE=s3://<your_s3_bucket_name_here>
export KOPS_STATE_STORE=s3://<your_s3_bucket_name_here>
#. Set the region to deploy in

.. code-block:: bash
export REGION=`curl -s http://169.254.169.254/latest/dynamic/instance-identity/document|grep region|awk -F\" '{print $4}'`
export REGION=`curl -s http://169.254.169.254/latest/dynamic/instance-identity/document|grep region|awk -F\" '{print $4}'`
#. Install the AWS CLI:

.. code-block:: bash
sudo apt-get update
sudo apt-get install awscli
sudo apt-get update
sudo apt-get install awscli
#. Set the availability zones for the nodes

Expand Down Expand Up @@ -136,7 +141,8 @@ The Procedure
Keep running 'kops validate cluster' until you see "Your cluster $NAME is ready" at the end of the output.

.. code-block:: bash
time until kops validate cluster; do sleep 15 ; done
time until kops validate cluster; do sleep 15 ; done
can be used to automate the waiting process.

Expand All @@ -148,7 +154,8 @@ The Procedure
Run::
.. code-block:: bash
kubectl get nodes
kubectl get nodes

You should see a list of two nodes, each beginning with ``ip``.
Expand All @@ -161,7 +168,8 @@ The Procedure
If you wish to put the kube config file in a different location, you will need to

.. code-block:: bash
export KUBECONFIG=<other kube config location>
export KUBECONFIG=<other kube config location>
#. Configure ssh bastion (Skip this step if you did not go with the **--topology private** option above!)
Expand Down Expand Up @@ -275,7 +283,8 @@ Then perform the following steps:
#. You can verify encryption is turned on with the following command:

.. code-block:: bash
kubectl exec -n kube-system weave-net-<pod> -c weave -- /home/weave/weave --local status
kubectl exec -n kube-system weave-net-<pod> -c weave -- /home/weave/weave --local status
You should see `encryption: enabled`

Expand Down
14 changes: 5 additions & 9 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,12 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.mathjax',
'sphinx_copybutton']
'sphinx_copybutton',
'recommonmark']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}


def setup(app):
app.add_config_value('recommonmark_config', {
'enable_eval_rst': True,
Expand Down Expand Up @@ -76,7 +72,7 @@ def setup(app):
#
# The short X.Y version of documentation.
with open('../../jupyterhub/Chart.yaml') as f:
chart = yaml.load(f)
chart = yaml.safe_load(f)
version = chart['version'].split('-', 1)[0]
# The full version of documentation, including alpha/beta/rc tags.
release = chart['version']
Expand Down Expand Up @@ -110,7 +106,7 @@ def setup(app):
# a list of builtin themes.
#

html_theme = 'pandas_sphinx_theme'
html_theme = 'pydata_sphinx_theme'

html_favicon = '_static/images/logo/favicon.ico'
html_logo = '_static/images/logo/logo.png'
Expand Down Expand Up @@ -202,7 +198,7 @@ def setup(app):

# Generate the JSON schema markdown file for the reference docs.
with open('../../jupyterhub/schema.yaml') as f:
data = yaml.load(f)
data = yaml.safe_load(f)

def parse_yaml(yaml, count=0, pre=''):
"""Generate markdown headers from the schema yaml."""
Expand Down
2 changes: 1 addition & 1 deletion doc/source/customizing/user-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ auth:
## Authenticating Users

For information on authenticating users in JupyterHub, see
[the Authentication guide](../../administrator/authentication.html).
[the Authentication guide](../administrator/authentication).

0 comments on commit 4c5dc3d

Please sign in to comment.