diff options
author | Clement Tsang <34804052+ClementTsang@users.noreply.github.com> | 2023-02-03 03:05:18 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-02-03 03:05:18 -0500 |
commit | a94a8059da0c523b4bebee2a99fc071a99689bcc (patch) | |
tree | 1700a314393c14aff02a76f687ad75b613c2927a /docs/README.md | |
parent | d72f75cdce8a7cf02b2dafc1e24ce6089528ed28 (diff) |
docs: add docs on process kill, update docs on updating docs (#1010)
* docs: add some documentation on process term, update captions
* docs on updating docs
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..33d89d17 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,47 @@ +# Extended Documentation + +This is where the extended documentation resides, hosted on GitHub Pages. We use [MkDocs](https://www.mkdocs.org/), +[Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), and [mike](https://github.com/jimporter/mike). + +## Running locally + +```bash +# Change directories to the documentation. +cd docs/ + +# Create and activate venv. +python -m venv venv +source venv/bin/activate + +# Install requirements +pip install -r requirements.txt + +# Run mkdocs +venv/bin/mkdocs serve +``` + +## Deploying + +Deploying is done via [mike](https://github.com/jimporter/mike). + +### Nightly + +```bash +cd docs +mike deploy nightly --push +``` + +### Stable + +```bash +cd docs + +# Rename the previous stable version +mike retitle --push stable $OLD_STABLE_VERSION + +# Set the newest version as the most recent stable version +mike deploy --push --update-aliases $RELEASE_VERSION stable + +# Append a "(stable)" string to the end. +mike retitle --push $RELEASE_VERSION "$RELEASE_VERSION (stable)" +``` |