diff --git a/docs/conf.py b/docs/conf.py index b373e4f..dc1e899 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,7 +17,9 @@ def setup(app): app.add_javascript("https://cdn.jsdelivr.net/npm/clipboard@1/dist/clipboard.min.js") # Enable MathJax for Math -extensions = ['sphinx.ext.mathjax', 'sphinx_copybutton.sphinx_copybutton'] +extensions = ['sphinx.ext.mathjax', + 'sphinx.ext.intersphinx', + 'sphinx_copybutton.sphinx_copybutton'] # The master toctree document. master_doc = 'index' @@ -26,7 +28,13 @@ master_doc = 'index' # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', - 'tutorials/custom.rst'] + 'install/custom.rst'] + +intersphinx_mapping = { + 'sphinx': ('http://www.sphinx-doc.org/en/master/', None), +} + +intersphinx_cache_limit = 90 # days # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' diff --git a/docs/index.rst b/docs/index.rst index 52bf9aa..96c6590 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,10 +30,7 @@ Ubuntu 18.04. We have a bunch of tutorials to get you started. install/digitalocean install/jetstream install/google - -- :ref:`install/custom`. - You should use this if your cloud provider does not already have a direct tutorial, - or if you have experience setting up servers. + install/custom-server Once you are ready to run your server for real, it's a good idea to proceed directly to :doc:`howto/https`. diff --git a/docs/install/custom.rst b/docs/install/custom-server.rst similarity index 94% rename from docs/install/custom.rst rename to docs/install/custom-server.rst index 645f707..c340827 100644 --- a/docs/install/custom.rst +++ b/docs/install/custom-server.rst @@ -4,6 +4,12 @@ Installing on your own server ============================= +.. note:: + + You should use this if your cloud provider does not already have a direct tutorial, + or if you have experience setting up servers. + + Goal ==== diff --git a/docs/topic/authenticator-configuration.rst b/docs/topic/authenticator-configuration.rst index af50c0a..0341761 100644 --- a/docs/topic/authenticator-configuration.rst +++ b/docs/topic/authenticator-configuration.rst @@ -27,7 +27,7 @@ Setting authenticator properties JupyterHub authenticators are customized by setting *traitlet properties*. In the authenticator's documentation, you will find these are usually represented as: -.. code-block:: +.. code-block:: python c.. = @@ -40,7 +40,7 @@ You can set these with ``tljh-config`` with: Example ------- -LDAPAuthenticator's `documentation `_ +`LDAPAuthenticator's documentation `_ lists the various configuration options you can set for LDAPAuthenticator. When the documentation asks you to set ``LDAPAuthenticator.server_address`` to some value, you can do that with the following command: diff --git a/docs/topic/security.rst b/docs/topic/security.rst index b59d911..b4d8d8f 100644 --- a/docs/topic/security.rst +++ b/docs/topic/security.rst @@ -50,7 +50,8 @@ even after you remove them from JupyterHub. Admins should manually remove the us from the server & archive their home directories as needed. For example, the following command deletes the unix user associated with the JupyterHub user ``yuvipanda``. -.. code-block:: +.. code-block:: bash + sudo userdel jupyter-yuvipanda If the user removed from the server is an admin, extra care must be taken @@ -69,4 +70,4 @@ HTTPS ===== Any internet-facing JupyterHub should use HTTPS to secure its traffic. For -information on how to use HTTPS with your JupyterHub, see :ref:`_howto/https`. +information on how to use HTTPS with your JupyterHub, see :ref:`howto/https`. diff --git a/docs/topic/whentouse.rst b/docs/topic/whentouse.rst index d2b77c8..2f66e2e 100644 --- a/docs/topic/whentouse.rst +++ b/docs/topic/whentouse.rst @@ -9,12 +9,12 @@ This page is a brief guide to determining whether to use The Littlest JupyterHub Many of these ideas were first laid out in a `blog post announcing TLJH `_. -**The Littlest JupyterHub (TLJH)** (`link `_) is an opinionated and pre-configured distribution +`**The Littlest JupyterHub (TLJH)** `_ is an opinionated and pre-configured distribution to deploy a JupyterHub on a **single machine** (in the cloud or on your own hardware). It is designed to be a more lightweight and maintainable solution for use-cases where size, scalability, and cost-savings are not a huge concern. -**Zero to JupyterHub on Kubernetes** (`link `_) allows you +`**Zero to JupyterHub on Kubernetes** `_ allows you to deploy JupyterHub on **Kubernetes**. This allows JupyterHub to scale to many thousands of users, to flexibly grow/shrink the size of resources it needs, and to use container technology in administering user sessions.