Tutorials

Gaffer Doc – A Comprehensive Guide To Building And Managing Documentation

Essential guide to mastering the documentation process for Gaffer. This article outlines step-by-step instructions on building and managing the latest Gaffer documentation using MkDocs and the Material theme.

Dive in to learn how to efficiently create, serve, and maintain your project’s documentation with ease.

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

Building The Documentation

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.

Prerequisites

Python

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

MkDocs Dependencies

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

Build The Documentation Site

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

mkdocs build

Build And Serve The Documentation Site (Recommended)

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.

Varshini

Varshini is a Cyber Security expert in Threat Analysis, Vulnerability Assessment, and Research. Passionate about staying ahead of emerging Threats and Technologies.

Recent Posts

Understanding the Model Context Protocol (MCP) and How It Works

Introduction to the Model Context Protocol (MCP) The Model Context Protocol (MCP) is an open…

5 days ago

The file Command – Quickly Identify File Contents in Linux

While file extensions in Linux are optional and often misleading, the file command helps decode what a…

5 days ago

How to Use the touch Command in Linux

The touch command is one of the quickest ways to create new empty files or update timestamps…

5 days ago

How to Search Files and Folders in Linux Using the find Command

Handling large numbers of files is routine for Linux users, and that’s where the find command shines.…

5 days ago

How to Move and Rename Files in Linux with the mv Command

Managing files and directories is foundational for Linux workflows, and the mv (“move”) command makes it easy…

5 days ago

How to Create Directories in Linux with the mkdir Command

Creating directories is one of the earliest skills you'll use on a Linux system. The mkdir (make…

5 days ago