docsbuild-scripts
Scripts for building the documentation on docs.python.org
File Explorer
- lint.yml
- test.yml
- dependabot.yml
- SECURITY.md
- zizmor.yml
- 404.html
- _docs_by_version.html
- indexsidebar.html
- robots.txt
- sitemap.xml
- switchers.js
- test_build_docs.py
- test_build_docs_version.py
- test_build_docs_versions.py
- .coveragerc
- .gitignore
- .pre-commit-config.yaml
- .ruff.toml
- build_docs.py
- check_times.py
- check_versions.py
- config.toml
- pyproject.toml
- README.md
- requirements.txt
- tools_requirements.txt
- tox.ini
# Use via CDN
jsDelivrjsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.
Command Glossary
Commands referenced in this DOCs, explained below.
screen
View Details ▼
screen
Hold a session open on a remote server. Manage multiple windows with a single SSH connection.
See also: `tmux`, `zellij`, `herdr`.
screen
Start a new screen session:
screen -S {{session_name}}
Start a new named screen session:
screen -dmLS {{session_name}} {{command}}
Start a new daemon and log the output to `screenlog.x`:
ssh
View Details ▼
ssh
Secure Shell is a protocol used to securely log onto remote systems.
It can be used for logging or executing commands on a remote server.
ssh {{username}}@{{remote_host}}
Connect to a remote server:
ssh {{username}}@{{remote_host}} -i {{path/to/key_file}}
Connect to a remote server with a specific [i]dentity (private key):
ssh {{username}}@10.0.0.1 -p {{2222}}
Connect to a remote server with IP `10.0.0.1` and using a specific [p]ort (Note: `10.0.0.1` can be shortened to `10.1`):
tox
View Details ▼
tox
Automate Python testing across multiple Python versions.
Use tox.ini to configure environments and test command.
tox
Run tests on all test environments:
tox-quickstart
Create a `tox.ini` configuration:
tox {{[-a|--listenvs-all]}}
List the available environments:
