fix absolute refs

myst seems to create different refs than sphinx
This commit is contained in:
Min RK
2023-03-27 09:56:46 +02:00
parent de36cfc116
commit 76dadd7ef9
29 changed files with 60 additions and 60 deletions

View File

@@ -24,7 +24,7 @@ not to have _perfect_ documentation before merging a pull request. If you
are new and not sure how to add documentation, other contributors will
be happy to guide you.
See {ref}`contributing/docs` for guidelines on writing documentation.
See [](/contributing/docs) for guidelines on writing documentation.
## Write tests
@@ -43,4 +43,4 @@ add more tests.
If you are unsure what kind of tests to add for your pull request, other
contributors to the repo will be happy to help guide you!
See {ref}`contributing/tests` for guidelines on writing tests.
See [](/contributing/tests) for guidelines on writing tests.

View File

@@ -68,5 +68,5 @@ The easiest & safest way to develop & test TLJH is with [Docker](https://www.doc
restart jupyterhub for them to take effect. `tljh-config reload hub`
should do that.
{ref}`troubleshooting/logs` has information on looking at various logs in the container
[](/troubleshooting/logs) has information on looking at various logs in the container
to debug issues you might have.

View File

@@ -59,7 +59,7 @@ If you encounter this error, it's likely that you are running inside a virtual e
Error in "currentmodule" directive:
```
To get started contributing, you'll want to read the {ref}`reStructuredText reference <sphinx:rst-index>`
To get started contributing, you'll want to read the `reStructuredText reference <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`
Your locally-built documentation will be themed differently than the
documentation at [the-littlest-jupyterhub.readthedocs.io](https://the-littlest-jupyterhub.readthedocs.io).

View File

@@ -20,7 +20,7 @@ stability required for a good plugin ecosystem.
## Installing Plugins
Include `--plugin <install_name>` in the Installer script. See {ref}`topic/customizing-installer` for more info.
Include `--plugin <install_name>` in the Installer script. See [](/topic/customizing-installer) for more info.
## Writing a simple plugins

View File

@@ -17,7 +17,7 @@ so attackers can not easily gain control of the system.
:::{important}
You should make sure an admin user is present when you **install** TLJH
the very first time. It is recommended that you also set a password
for the admin at this step. The {ref}`--admin <topic/customizing-installer/admin>`
for the admin at this step. The [`--admin`] (/topic/customizing-installer/admin)
flag passed to the installer does this. If you had forgotten to do so, the
easiest way to fix this is to run the installer again.
:::

View File

@@ -8,9 +8,9 @@ HTTPS encrypts traffic so that usernames, passwords and your data are
communicated securely. sensitive bits of information are communicated
securely. The Littlest JupyterHub supports automatically configuring HTTPS
via [Let's Encrypt](https://letsencrypt.org), or setting it up
{ref}`manually <howto/admin/https/manual>` with your own TLS key and
[manually](#howto-admin-https-manual) with your own TLS key and
certificate. Unless you have a strong reason to use the manual method,
you should use the {ref}`Let's Encrypt <howto/admin/https/letsencrypt>`
you should use the [Let's Encrypt](#howto-admin-https-letsencrypt)
method.
:::{note}
@@ -35,7 +35,7 @@ similar to this:
If the machine you are running on is not reachable from the internet -
for example, if it is a machine internal to your organization that
is cut off from the internet - you can not use this method. Please
set up a DNS entry and HTTPS {ref}`manually <howto/admin/https/manual>`.
set up a DNS entry and HTTPS [manually](#howto-admin-https-manual).
:::
To enable HTTPS via letsencrypt:
@@ -115,4 +115,4 @@ and now access your Hub securely at <https://yourhub.yourdomain.edu>.
## Troubleshooting
If you're having trouble with HTTPS, looking at the {ref}`traefik proxy logs <troubleshooting/logs/traefik>` might help.
If you're having trouble with HTTPS, looking at the [traefik proxy logs](troubleshooting-logs-traefik) might help.

View File

@@ -11,7 +11,7 @@ the cloud provider of your choice.
Currently there are instructions to resize your resources on the following providers:
- {ref}`Digital Ocean <howto/providers/digitalocean/resize>`.
- [Digital Ocean](howto-providers-digitalocean-resize)
Once resources have been reallocated, you must tell TLJH to make use of these resources,
and verify that the resources have become available.
@@ -20,7 +20,7 @@ and verify that the resources have become available.
1. Once you have resized your server, tell the JupyterHub to make use of
these new resources. To accomplish this, follow the instructions in
{ref}`topic/tljh-config` to set new memory or CPU limits and reload the hub. This can be completed
[](/topic/tljh-config) to set new memory or CPU limits and reload the hub. This can be completed
using the terminal in the JupyterHub (or via SSH-ing into your VM and using this terminal).
2. TLJH configuration options can be verified by viewing the tljh-config output.

View File

@@ -36,7 +36,7 @@ over time. We generally recommend between 40-60% of your total class size to sta
Depending on what kind of work your users are doing, they will use different amounts
of memory. The easiest way to determine this is to run through a typical user
workflow yourself, and measure how much memory is used. You can use {ref}`howto/admin/nbresuse`
workflow yourself, and measure how much memory is used. You can use [](/howto/admin/nbresuse)
to determine how much memory your user is using.
A good rule of thumb is to take the maximum amount of memory you used during

View File

@@ -102,7 +102,7 @@ c.GenericOAuthenticator.userdata_method = "POST"
```
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
For more information on `tljh-config`, see {ref}`topic/tljh-config`.
For more information on `tljh-config`, see [](/topic/tljh-config).
1. Tell your JupyterHub to use the GenericOAuthenticator for authentication:
@@ -125,4 +125,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
4. You will likely have to create a new user (sign up) and then you should be directed to the
Jupyter interface used in this JupyterHub.
5. **If this does not work** you can revert back to the default
JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`.
JupyterHub authenticator by following the steps in [](/howto/auth/firstuse).

View File

@@ -52,7 +52,7 @@ with the new IP address.
## Configure your JupyterHub to use the GitHub Oauthenticator
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
For more information on `tljh-config`, see {ref}`topic/tljh-config`.
For more information on `tljh-config`, see [](/topic/tljh-config).
1. Log in as an administrator account to your JupyterHub.
@@ -105,4 +105,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
Jupyter interface used in this JupyterHub.
5. **If this does not work** you can revert back to the default
JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`.
JupyterHub authenticator by following the steps in [](/howto/auth/firstuse).

View File

@@ -77,7 +77,7 @@ with the new IP address.
## Configure your JupyterHub to use the Google Oauthenticator
We'll use the `tljh-config` tool to configure your JupyterHub's authentication.
For more information on `tljh-config`, see {ref}`topic/tljh-config`.
For more information on `tljh-config`, see [](/topic/tljh-config).
1. Log in as an administrator account to your JupyterHub.
@@ -130,4 +130,4 @@ For more information on `tljh-config`, see {ref}`topic/tljh-config`.
Jupyter interface used in this JupyterHub.
5. **If this does not work** you can revert back to the default
JupyterHub authenticator by following the steps in {ref}`howto/auth/firstuse`.
JupyterHub authenticator by following the steps in [](/howto/auth/firstuse).

View File

@@ -4,13 +4,13 @@
This section covers how to add data to your JupyterHub either from the internet
or from your own machine. To learn how to **share data** that is already
on your JupyterHub, see {ref}`howto/content/share-data`.
on your JupyterHub, see [](/howto/content/share-data).
:::{note}
When you add data using the methods on this page, you will **only add it
to your user directory**. This is not a place that is accessible to others.
For information on sharing this data with users on the JupyterHub, see
{ref}`howto/content/share-data`.
[](/howto/content/share-data).
:::
## Adding data from your local machine
@@ -40,7 +40,7 @@ interface. To do so, follow these steps:
be on your JupyterHub, your home user's home directory.
To learn how to **share** this data with new users on the JupyterHub,
see {ref}`howto/content/share-data`.
see [](/howto/content/share-data).
## Downloading data from the command line
@@ -95,6 +95,6 @@ time. You can download it from your browser [at this link](https://swcarpentry.g
5. Confirm that your data was unzipped. It could be in a folder called `data/`.
To learn how to **share** this data with new users on the JupyterHub,
see {ref}`howto/content/share-data`.
see [](/howto/content/share-data).
% TODO: Downloading data with the "download" module in Python? https://github.com/choldgraf/download

View File

@@ -13,7 +13,7 @@ contained in the link's target repository is downloaded to the user's home
directory. Note that a copy of the dataset will be made for each user.
For information on creating and sharing `nbgitpuller` links, see
{ref}`howto/content/nbgitpuller`.
[](/howto/content/nbgitpuller).
## Option 2: Create a read-only shared folder for data
@@ -37,7 +37,7 @@ steps:
sudo mkdir -p /srv/data/my_shared_data_folder
```
4. **Download the data** into this folder. See {ref}`howto/content/add-data` for
4. **Download the data** into this folder. See [](/howto/content/add-data) for
details on how to do this.
5. All users now have read access to the data in this folder.

View File

@@ -28,7 +28,7 @@ env/server-resources
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`
[](/topic/authenticator-configuration)
```{toctree}
:titlesonly: true

View File

@@ -39,4 +39,4 @@ disk space, or CPUs. Digital Ocean servers can be resized in the
Now that you've resized your Droplet, you may want to change the resources available
to your users. Further information on making more resources available to
users and verifying resource availability can be found in {ref}`howto/admin/resize`.
users and verifying resource availability can be found in [](/howto/admin/resize).

View File

@@ -2,7 +2,7 @@
A simple [JupyterHub](https://github.com/jupyterhub/jupyterhub) distribution for
a small (0-100) number of users on a single server. We recommend reading
{ref}`topic/whentouse` to determine if this is the right tool for you.
[](/topic/whentouse) to determine if this is the right tool for you.
## Development Status

View File

@@ -27,4 +27,4 @@ The packages ``gdal`` and ``there`` are now available to all users in JupyterHub
If a user already had a python notebook running, they have to restart their notebook's
kernel to make the new libraries available.
See :ref:`howto/env/user_environment` for more information.
See :ref:`howto-env-user-environment` for more information.

View File

@@ -72,7 +72,7 @@ Let's create the server on which we can run JupyterHub.
offers. Select the one you want and then select the button
`Next: Configure Instance Details` in the lower right corner.
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
how much Memory / CPU your server needs.
We recommend you use a server with at least 2GB of RAM, such as a **t3.small**.
However, if you need to minimise costs you can use a server with **1GB** RAM such as a **t2.micro**, but performance will be limited.
@@ -101,8 +101,8 @@ Let's create the server on which we can run JupyterHub.
```
:::{note}
See {ref}`topic/installer-actions` for a detailed description and
{ref}`topic/customizing-installer` for other options that can be used.
See [](/topic/installer-actions) for a detailed description and
[](/topic/customizing-installer) for other options that can be used.
:::
8. Under **Step 4: Add Storage**, you can change the **size** and **type of your
@@ -112,7 +112,7 @@ Let's create the server on which we can run JupyterHub.
:alt: Selecting disk size and type
```
Check out {ref}`howto/admin/resource-estimation` to help pick
Check out [](/howto/admin/resource-estimation) to help pick
how much Disk space your server needs.
Hover over the encircled `i` next to **Volume Type** for an explanation of

View File

@@ -161,8 +161,8 @@ A new screen with all the options for Virtual Machines in Azure will displayed.
```
:::{note}
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
[](/topic/customizing-installer) documents other options that can be passed to the installer.
:::
8. Check the summary and confirm the creation of your Virtual Machine.

View File

@@ -14,7 +14,7 @@ on your personal computer.
:::{note}
Running TLJH _inside_ a docker container is not supported, since we depend
on systemd. If you want to run TLJH locally for development, see
{ref}`contributing/dev-setup`.
[](/contributing/dev-setup).
:::
## Goal
@@ -31,7 +31,7 @@ a server you have access to.
4. Ability to `ssh` into the server & run commands from the prompt.
5. An **IP address** where the server can be reached from the browsers of your target audience.
If you run into issues, look at the specific {ref}`troubleshooting guide <troubleshooting/providers/custom>`
If you run into issues, look at the specific [troubleshooting guide](/troubleshooting/providers/custom)
for custom server installations.
## Step 1: Installing The Littlest JupyterHub
@@ -56,8 +56,8 @@ for custom server installations.
```
:::{note}
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
[](/topic/customizing-installer) documents other options that can be passed to the installer.
:::
4. Press `Enter` to start the installation process. This will take 5-10 minutes,
@@ -92,4 +92,4 @@ for custom server installations.
## Step 4: Setup HTTPS
Once you are ready to run your server for real, and have a domain, it's a good
idea to proceed directly to {ref}`howto/admin/https`.
idea to proceed directly to [](/howto/admin/https).

View File

@@ -40,7 +40,7 @@ Let's create the server on which we can run JupyterHub.
(4GB RAM, 2CPUs, 20 USD / month) is not a bad start. You can resize your server
later if you need.
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
how much Memory, CPU & disk space your server needs.
5. Scroll down to **Select additional options**, and select **User data**.
@@ -66,8 +66,8 @@ Let's create the server on which we can run JupyterHub.
```
:::{note}
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
[](/topic/customizing-installer) documents other options that can be passed to the installer.
:::
7. Under the **Finalize and create** section, enter a `hostname` that descriptively

View File

@@ -84,7 +84,7 @@ Let's create the server on which we can run JupyterHub.
:alt: Select a customized VM size
```
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
how much Memory / CPU your server needs.
11. Under **Boot Disk**, click the **Change** button. This lets us change the
@@ -113,7 +113,7 @@ Let's create the server on which we can run JupyterHub.
to a hard drive. **SSD persistent disk** gives you a faster but more expensive
disk, similar to an SSD.
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
how much Disk space your server needs.
14. Click the **Select** button to dismiss the Boot disk popup and go back to the
@@ -160,8 +160,8 @@ Let's create the server on which we can run JupyterHub.
```
:::{note}
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
[](/topic/customizing-installer) documents other options that can be passed to the installer.
:::
19. Click the **Create** button at the bottom to start your server!

View File

@@ -55,7 +55,7 @@ Let's create the server on which we can run JupyterHub.
2. Select an appropriate **Instance Size**. We suggest m1.medium or larger.
Make sure your instance has at least **1GB** of RAM.
Check out our guide on How To {ref}`howto/admin/resource-estimation` to help pick
Check out our guide on How To [](/howto/admin/resource-estimation) to help pick
how much Memory, CPU & disk space your server needs.
3. If you have multiple allocations, make sure you are 'charging' this server
@@ -93,8 +93,8 @@ Let's create the server on which we can run JupyterHub.
```
:::{note}
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
[](/topic/customizing-installer) documents other options that can be passed to the installer.
:::
9. Under **Execution Strategy Type**, select **Run script on first boot**.

View File

@@ -77,8 +77,8 @@ Let's create the server on which we can run JupyterHub.
```
:::{note}
See {ref}`topic/installer-actions` if you want to understand exactly what the installer is doing.
{ref}`topic/customizing-installer` documents other options that can be passed to the installer.
See [](/topic/installer-actions) if you want to understand exactly what the installer is doing.
[](/topic/customizing-installer) documents other options that can be passed to the installer.
:::
```{image} ../images/providers/ovh/configuration.png

View File

@@ -10,7 +10,7 @@ can be used with TLJH. A number of them ship by default with TLJH:
OAuth based authentication methods.
2. [LDAPAuthenticator](https://github.com/jupyterhub/ldapauthenticator) - LDAP & Active Directory.
3. [DummyAuthenticator](https://github.com/yuvipanda/jupyterhub-dummy-authenticator) - Any username,
one shared password. A {ref}`how-to guide on using DummyAuthenticator <howto/auth/dummy>` is also
one shared password. A [how-to guide on using DummyAuthenticator](howto-auth-dummy) is also
available.
4. [FirstUseAuthenticator](https://github.com/yuvipanda/jupyterhub-firstuseauthenticator) - Users set
their password when they log in for the first time. Default authenticator used in TLJH.
@@ -75,7 +75,7 @@ sudo tljh-config reload
Try logging in a separate incognito window to check if your configuration works. This
lets you preserve your terminal in case there were errors. If there are
errors, {ref}`troubleshooting/logs` should help you debug them.
errors, [](/troubleshooting/logs) should help you debug them.
### Example

View File

@@ -110,7 +110,7 @@ The Littlest JupyterHub can install additional _plugins_ that provide additional
features. They are most commonly used to install a particular _stack_ - such as
the [PANGEO Stack](https://github.com/yuvipanda/tljh-pangeo) for earth sciences
research, a stack for a particular class, etc. You can find more information about
writing plugins and a list of existing plugins at {ref}`contributing/plugins`.
writing plugins and a list of existing plugins at [](/contributing/plugins).
`--plugin <plugin-to-install>` installs and activates a plugin. You can pass it
however many times you want. Since plugins are distributed as python packages,

View File

@@ -20,4 +20,4 @@ about how to get HTTP traffic from the world into your server.
## CPU / Memory / Disk Space
See how to {ref}`howto/admin/resource-estimation`
See how to [](/howto/admin/resource-estimation)

View File

@@ -66,4 +66,4 @@ feature of systemd.
## 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/admin/https`.
information on how to use HTTPS with your JupyterHub, see [](/howto/admin/https).

View File

@@ -37,7 +37,7 @@ logs is a great first step.
sudo journalctl -u jupyterhub
```
This command displays logs from JupyterHub itself. See {ref}`journalctl_tips`
This command displays logs from JupyterHub itself. See [](#journalctl-tips)
for tips on navigating the logs.
(troubleshooting-logs-traefik)=
@@ -52,7 +52,7 @@ is one line cryptic error messages, or if you are having trouble with HTTPS.
sudo journalctl -u traefik
```
This command displays logs from Traefik. See {ref}`journalctl_tips`
This command displays logs from Traefik. See [](#journalctl-tips)
for tips on navigating the logs.
## User Server Logs
@@ -67,7 +67,7 @@ sudo journalctl -u jupyter-<name-of-user>
This command displays logs from the given user's notebook server. You can get a
list of all users from the "users" button at the top-right of the Admin page.
See {ref}`journalctl_tips` for tips on navigating the logs.
See [](#journalctl-tips) for tips on navigating the logs.
(journalctl-tips)=