Switch to sphinx+rtd for documentation

- mkdocs doesn't support GFMD, so is a different dialect
- recommonmark seems abandoned
- Couldn't get m2r to work

So RST + Sphinx it is!
This commit is contained in:
yuvipanda
2018-06-28 00:39:55 -07:00
parent 8401012ab6
commit aa01225b0a
8 changed files with 152 additions and 52 deletions

42
docs/install.rst Normal file
View File

@@ -0,0 +1,42 @@
.. _installation:
Installation
============
Quick Installation
------------------
The quick way to install The Littlest JupyterHub (tljh) is:
.. code-block:: bash
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash | sudo bash -
This takes 2-5 minutes to run. When completed, you can access your new JupyterHub
at the public IP of your server!
You should probably add yourself as an `admin user <admin.md>`_
after installation.
Slightly less quick installation
--------------------------------
If you can read ``bash`` and are nervous about the previous installation method,
you can inspect the installer script before running it.
1. Download the installer script
.. code-block:: bash
curl https://raw.githubusercontent.com/yuvipanda/the-littlest-jupyterhub/master/installer/install.bash -o install.bash
2. Read the install script source using your favorite text editor
3. Run the installer script
.. code-block:: bash
sudo install.bash
This should have the exact same effects as the quick installer method.