The website was made using the following:

• MkDocs
• Material for MkDocs
• Material for MkDocs Extensions
• PyMdown Extensions
• Awesome Nav for MkDocs
• mkdocstrings
• mkdocs-autorefs
• mkdocs-section-index
• MkDocs Site URLs
• mkdocs-git-revision-date-localized-plugin
• Mkdocs-Macros

Automatic code documentations assumes google-style docstrings. For examples on how to format google-style docstrings, see here: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html

To install

Note for Mac Users: On a Mac with Apple Silicon it may be necessary to first install some relevant libraries that are needed for OpenDSM:

brew install openblas
brew install lapack

Each of the above will also prompt you to set some environment variables with commands like export LDFLAGS="/some/appropriate/location/", so run these commands one at a time and look at the tail end of the output for instruction.

To install the necessary packages, run the following from the opendsm-website directory

python3 -m venv .venv
. .venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install -r requirements.txt
python3 -m mkdocs serve

To run

From opendsm-website directory run:

. .venv/bin/activate
python3 -m mkdocs serve