History

Twan Stok 1b1e80ec3c feature: add buffer and cache memory (#1063 ) * First implementation of cache memory data collection, mostly copied from RAM and swap implementations * First implementation of cache memory display, copied from RAM and swap implementations. placed cache as second in the list as it is more similar to the RAM than any other item in the list * expanded comment to explain method. * rustfmt * all cache-related code excluded on windows, in the process refactored src/data_conversion.rs convert_mem_label() to convert a single label instead of all at once * better factoring-out of cache memory logic to allow individual disabling * added --enable_cache_memory flag, disabled cache memory collection by default * renamed CCH to CHE not sure how i messed that up * changelog updated * Added command line flag documentation * updated config file documentation * specified that buffer and cache memory display does not work on windows * resolved merge conflicts * added documentation to cache memory data collection * capitalized Windows * implemented missing canvas styling logic * fixed misplaced no-windows flag * reduced colour collisions, as cache colour was the same as the first GPU colour * made FIFTH_COLOUR constant windows-only * Revert "made FIFTH_COLOUR constant windows-only" This reverts commit `72698f1dd7`. * made FIFTH_COLOUR constant non-windows-only * minor fix for basic mode row count * Update src/app/data_harvester/memory/sysinfo.rs Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> * Update src/canvas/widgets/mem_basic.rs Co-authored-by: Clement Tsang <34804052+ClementTsang@users.noreply.github.com> * updated default_config.toml * formatting --------- Co-authored-by: ClementTsang <34804052+ClementTsang@users.noreply.github.com>		2023-04-12 22:51:41 -04:00
..
content	feature: add buffer and cache memory (#1063 )	2023-04-12 22:51:41 -04:00
.gitignore	docs: adjust dev doc file structure, add build and deploy docs (#804 )	2022-09-12 04:14:19 -04:00
README.md	docs: add script to serve mkdocs locally	2023-02-04 04:58:16 -05:00
mkdocs.yml	docs: make stable docs the default (#958 )	2023-01-05 21:08:17 -05:00
requirements.txt	docs: update mkdocs-material to 9.1.6 (#1089 )	2023-04-08 01:33:51 -04:00
serve.sh	docs: add script to serve mkdocs locally	2023-02-04 04:58:16 -05:00

README.md

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)"