To get started with local development, clone repo docs and spack-ucdavis repos:
git clone [email protected]:ucdavis/hpccf-docs.git
git clone [email protected]:ucdavis/spack-ucdavis.git
cd hpccf-docs
ln -s ../spack-ucdavis .
Then create a virtual environment, either with virtualenv
:
python -m virtualenv venv
. venv/bin/activate
Or with conda
:
conda create -n mkdocs
conda activate mkdocs
Then install the dependencies:
python -m pip install -r requirements.txt
You can serve the documentation locally by running:
mkdocs serve
Once the environment is created and dependencies installed, you only need to activate it in the future.
mkdocs
docs: https://www.mkdocs.org/