This project has been archived and is no longer under active maintenance. Should you have any questions or require further information, please do not hesitate to reach out to us at the following email address.

oss@gchq.gov.uk

This repository contains all the documentation for Gaffer, which is published here.

For instructions for building Gaffer's v1 documentation, see the v1docs branch. The current Gaffer docs are built using MkDocs with the Material theme. We use Mike for documentation versioning. Running mike is handled by GitHub Actions, so it isn't something most contributors will need to use unless you make changes to that part of the project.

You need Python (version 3.8 or newer) installed to use MkDocs.

You need MkDocs and the Material theme to generate the documentation. The versions we are using can be installed from the requirements.txt:

pip install -r requirements.txt

To generate static documentation files and place them into the default site directory:

mkdocs build

Docs can be build and served locally (on localhost:8000) by using:

mkdocs serve

This automatically updates and refreshes when local changes are made. Although it might take a few seconds due to the amount of content.