Documentation source code repository for Merlin C2 at https://merlin-c2.readthedocs.io
This repository contains documentation for the following Merlin components and their individual version numbers:
Use the following steps to build and view the documentation locally:
- OPTIONAL - Create a Python virtual environment:
python -m venv .venv - OPTIONAL - Activate the Python virtual environment:
source .venv/bin/activate - Ensure the Python
sphinx& required packages are installed with:python -m pip install sphinx sphinx_rtd_theme recommonmark - Build the documentation with:
sphinx-build -b html docs/source/ docs/build/html - Open docs/build/html/index.html
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