mirror of
https://github.com/ClementTsang/bottom.git
synced 2026-05-19 05:10:47 +00:00
Clement Tsang
d08036f69a
<!-- Please use this template (unless you have a very good reason not to). PRs that do not use the template may be closed. --> ## Description _A description of the change, what it does, and why it was made. If relevant (e.g. UI changes), **please also provide screenshots/recordings**:_ Rename a bunch of code/struct field names to use "colour". Note this should have no functional change to config settings as I was already aliasing "colour" for "color" settings, this just flips it internally. As for why, I'm Canadian, I grew up spelling it this way, sorry. ## Issue _If applicable, what issue does this address?_ Closes: #<issue-number> ## Testing _If relevant, please state how this was tested (including steps):_ _If this change affects the program, please also indicate which platforms were tested:_ - [ ] _Windows_ - [ ] _macOS (specify version below)_ - [x] _Linux (specify distro below)_ - [ ] _Other (specify below)_ ## Checklist _Ensure **all** of these are met:_ - [x] _If this PR adds or changes a dependency, please justify this in the description_ - [x] _If this is a code change, areas your change affects have been linted using (`cargo fmt`)_ - [x] _If this is a code change, your changes pass `cargo clippy --all -- -D warnings`_ - [x] _If this is a code change, new tests were added if relevant_ - [x] _If this is a code change, your changes pass `cargo test`_ - [x] _The change has been tested to work (see above) and doesn't appear to break other things_ - [x] _Documentation has been updated if needed (`README.md`, help menu, docs, configs, etc.)_ - [x] _There are no merge conflicts_ - [x] _You have reviewed your changes first_ - [x] _The pull request passes the provided CI pipeline_ ## Other _Anything else that maintainers should know about this PR:_
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, assuming your current working directory
is the bottom repo:
# 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 in order to get versioning. Typically, this is done through CI, but can be done manually if needed.
Nightly docs
cd docs
mike deploy nightly --push
Stable docs
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)"