tymyrddin / documentation

Improving our documentation skills

SecOpsDev Documentation

Built with Sphinx using a theme provided by Read the Docs.

Requirements

• sphinx — sphinx package
• sphinx-rtd-theme — a theme package
• myst-parser — parsing .md files
• sphinx-markdown-tables — package for Markdown tables support

Usage

Add or change documents in the source folder.

Make the build:

$ make html

Problems or Suggestions

This project welcomes contributions and suggestions.

Open an issue here

Mind

"Shut up and tell me what that other idiot ish doing!" "No, but look, if I've got to shut up, how can I --" The knife at his throat became a hot streak of pain and Rincewind decided to give logic a miss. ~ Cohen the Barbarian interrogates Rincewind (Terry Pratchett, The Light Fantastic)