You've reached the repository that powers the G-ADOPT website. It's powered by MkDocs, using the Material for MkDocs theme. API documentation is generated using mkdocstrings.
For simple development on the main content of the site, first make sure that you have installed uv by following the installation instructions for your platform. Clone this repository, and change to its directory. Start the MkDocs server, and the site will be available at http://localhost:8000
$ uv run -- mkdocs serve
If you're working on the API documentation, there's an extra step
regarding the repository from which to build the documentation. By
default, MkDocs will look for a clone of g-adopt at the g-adopt
path inside this repository. If you'd prefer to work with the
repository at a different path, change the following key in the
mkdocs.yml file:
plugins:
- mkdocstrings:
handlers:
python:
paths: ...Changes to the live website are automatically deployed from pushes to
the main branch.