This directory contains the source for the Nessie docs site.

• Site structure is maintained in mkdocs.yml
• Pages are maintained in markdown in the docs/ folder
• Links use bare page names: [link text](target-page)

The site is built using mkdocs. To install mkdocs and the theme, run:

pip install -r ./requirements.txt

To see changes locally before committing, use mkdocs to run a local server from this directory.

mkdocs serve

We have a GitHub action that will automatically deploy any changes to the site.

1. Enter into python directory and activate venv.
2. Run make docs.

1. from root run mvn javadoc:aggregate
2. cp -R target/site/apidocs/* site/docs/javadoc