Skip to content

Docs

How to update project documentation / Website

Requirements

pip install mkdocs
pip install wheel
pip install pymdown-extensions
pip install mike

Test / Deploy

This project is using Mike to deploy gh-pages with version.

Perform Local test of the docs. http://127.0.0.1:8888

1
mkdocs serve

Notice

Not needed to build if you are hosting on gh-pages. Output folder: `docs/public'

1
2
# Build - local files (If desired)
mkdocs build

Content is published by Mike and uses gh-pages.

References:

  • https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/?h=mike#versioning
  • https://github.com/jimporter/mike
1
2
# Deploy - default version: dev
mike deploy [version]