Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 568 Bytes

readme.md

File metadata and controls

20 lines (13 loc) · 568 Bytes

Docs

Docs are generated using MkDocs-Material. This is controlled by the mkdocs.yml file in the root directory.

Deployment

Deployment should occur automatically on push to master with action.yml. This should be configured in the REPO settings as well.

Development

To locally test mkdocs, the best option is to run on the serve command with:

mkdocs serve -a <0.0.0.0:unused_port>

Requirmenets

  • mkdocs-material
  • mkdocs-jupyter