mirror of
https://github.com/ClementTsang/bottom.git
synced 2025-09-24 10:18:38 +02:00
b07f940970
* hide k-threads init comment * add config for hide_k_threads arg help * update docs for hide_k_threads * add test_toggle_k_thread for process_table * update help text and schema * add hide_k_threads to sample_configs default * add Virt column to sample default config * update sample demo config column name for schema ci * force_rerender_and_update from toggle_k_threads for updates when frozen * use is_kernel for ProcessType * remove todo * Apply suggestions from code review Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> --------- Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com>
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)"