Merlin Documentation

Documentation source code repository for Merlin C2 at https://merlin-c2.readthedocs.io

Supported Versions

This repository contains documentation for the following Merlin components and their individual version numbers:

• Merlin Server v2.0.0
• Merlin CLI
• Merlin Agent v2.0.0
• Merlin Agent DLL v2.0.0

Build & View

Use the following steps to build and view the documentation locally:

1. OPTIONAL - Create a Python virtual environment: python -m venv .venv
2. OPTIONAL - Activate the Python virtual environment: source .venv/bin/activate
3. Ensure the Python sphinx & required packages are installed with: python -m pip install sphinx sphinx_rtd_theme recommonmark
4. Build the documentation with: sphinx-build -b html docs/source/ docs/build/html
5. Open docs/build/html/index.html

Layout

The project's directory layout is:

• docs/CHANGELOG.MD - This project's changelog
• docs/build - Rendered documentation ready to be viewed in a browser
• docs/source - Source reStructuredText documentation files