Writing Documentation

Documentation for this project is built using mkdocs with the material theme and hosted using GitHub Pages. The documentation source files are in the docs/ directory and are authored using markdown.

Local Development

To write documentation for this project, make sure that the build tools are installed. In a Python environment and in the data-infrastructure repo, you should be able to start a local server for the docs by running:

mkdocs serve

Then open a web browser to http://localhost:8000 to view the built docs. Any edits you make to the markdown sources should be automatically picked up, and the page should automatically rebuild and refresh.

Deployment

Deployment of the docs for this repository is done automatically upon merging to main using the docs GitHub Action.

Built documentation is pushed to the gh-pages branch of the repository, and can be viewed by navigating to https://cagov.github.io/data-infrastructure.