mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-10 06:34:16 +00:00
e4f3b6911a
- There is currently no indication under which [table](https://toml.io/en/v1.0.0#table) do "flags" go in the config file. - I think having that being explicitly spelled out & having an example saves quite a bit of people's time. Would for me 🙃 |
||
---|---|---|
.. | ||
content | ||
.gitignore | ||
mkdocs.yml | ||
README.md | ||
requirements.txt | ||
serve.sh |
Extended Documentation
This is where the extended documentation resides, hosted on GitHub Pages. We use MkDocs, Material for MkDocs, and mike.
Documentation is currently built using Python 3.11, though it should work fine with older versions.
Running locally
One way is to just run serve.sh
. Alternatively, the manual steps are:
# 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.
Nightly
cd docs
mike deploy nightly --push
Stable
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)"