hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-18 15:33:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4741 from manics/docs-py-min

Browse Source 
Consistently use minimum Python version in docs
This commit is contained in:
Min RK
2024-03-22 08:55:05 +01:00
committed by GitHub
parent 6ade08825b 352826a1ec
commit 4cf007b515
4 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -56,7 +56,7 @@ for administration of the Hub and its users.
### Check prerequisites ### Check prerequisites
- A Linux/Unix based system - A Linux/Unix based system
- [Python](https://www.python.org/downloads/) 3.6 or greater - [Python](https://www.python.org/downloads/) 3.8 or greater
- [nodejs/npm](https://www.npmjs.com/) - [nodejs/npm](https://www.npmjs.com/)
- If you are using **`conda`**, the nodejs and npm dependencies will be installed for - If you are using **`conda`**, the nodejs and npm dependencies will be installed for

2
docs/source/conf.py
View File

@@ -70,6 +70,8 @@ myst_enable_extensions = [
myst_substitutions = { myst_substitutions = {
# date example: Dev 07, 2022 # date example: Dev 07, 2022
"date": datetime.date.today().strftime("%b %d, %Y").title(), "date": datetime.date.today().strftime("%b %d, %Y").title(),
"node_min": "12",
"python_min": "3.8",
"version": jupyterhub.__version__, "version": jupyterhub.__version__,
} }

8
docs/source/contributing/setup.md
View File

@@ -12,18 +12,18 @@ development.
### Install Python ### Install Python
JupyterHub is written in the [Python](https://python.org) programming language and JupyterHub is written in the [Python](https://python.org) programming language and
requires you have at least version 3.8 installed locally. If you haven’t requires you have at least version {{python_min}} installed locally. If you haven’t
installed Python before, the recommended way to install it is to use installed Python before, the recommended way to install it is to use
[Miniforge](https://github.com/conda-forge/miniforge#download). [Miniforge](https://github.com/conda-forge/miniforge#download).
### Install nodejs ### Install nodejs
[NodeJS 12+](https://nodejs.org/en/) is required for building some JavaScript components. [NodeJS {{node_min}}+](https://nodejs.org/en/) is required for building some JavaScript components.
`configurable-http-proxy`, the default proxy implementation for JupyterHub, is written in Javascript. `configurable-http-proxy`, the default proxy implementation for JupyterHub, is written in Javascript.
If you have not installed NodeJS before, we recommend installing it in the `miniconda` environment you set up for Python. If you have not installed NodeJS before, we recommend installing it in the `miniconda` environment you set up for Python.
You can do so with `conda install nodejs`. You can do so with `conda install nodejs`.
Many in the Jupyter community use \[`nvm`\](<https://github.com/nvm-sh/nvm>) to Many in the Jupyter community use [`nvm`](https://github.com/nvm-sh/nvm) to
managing node dependencies. managing node dependencies.
### Install git ### Install git
@@ -59,7 +59,7 @@ a more detailed discussion.
python -V python -V
``` ```
This should return a version number greater than or equal to 3.8. This should return a version number greater than or equal to {{python_min}}.
```bash ```bash
npm -v npm -v

6
docs/source/tutorial/quickstart.md
View File

@@ -5,11 +5,11 @@
Before installing JupyterHub, you will need: Before installing JupyterHub, you will need:
- a Linux/Unix-based system - a Linux/Unix-based system
- [Python](https://www.python.org/downloads/) 3.6 or greater. An understanding - [Python {{python_min}}](https://www.python.org/downloads/) or greater. An understanding
of using [`pip`](https://pip.pypa.io) or of using [`pip`](https://pip.pypa.io) or
[`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) for [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/getting-started.html) for
installing Python packages is helpful. installing Python packages is helpful.
- [nodejs/npm](https://www.npmjs.com/). [Install nodejs/npm](https://docs.npmjs.com/getting-started/installing-node), - [Node.js {{node_min}}](https://www.npmjs.com/) or greater, along with npm. [Install Node.js/npm](https://docs.npmjs.com/getting-started/installing-node),
using your operating system's package manager. using your operating system's package manager.
- If you are using **`conda`**, the nodejs and npm dependencies will be installed for - If you are using **`conda`**, the nodejs and npm dependencies will be installed for
@@ -24,7 +24,7 @@ Before installing JupyterHub, you will need:
``` ```
[nodesource][] is a great resource to get more recent versions of the nodejs runtime, [nodesource][] is a great resource to get more recent versions of the nodejs runtime,
if your system package manager only has an old version of Node.js (e.g. 10 or older). if your system package manager only has an old version of Node.js.
- A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module) - A [pluggable authentication module (PAM)](https://en.wikipedia.org/wiki/Pluggable_authentication_module)
to use the [default Authenticator](authenticators). to use the [default Authenticator](authenticators).