This repository contains user documentation for the EasyDiffraction library.
- Develop branch
- Master branch
- Create virtual environment and activate it (optional)
python -m venv .venv
source .venv/bin/activate
- Upgrade pip (optional)
pip install --upgrade pip
- Install Material for MkDocs documentation framework as well as Jupyter plugin for MkDocs (if not done already)
pip install mkdocs-material mkdocs-jupyter
- Generate documentation from the files in docs/ and places it in site/
mkdocs build