You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
suricata/doc/userguide/devguide
Juliana Fajardini 6f77c722a2 devguide: move into userguide as last chapter
Moved devguide dir into userguide dir.
Since the devguide is now incorporated as the last chapter of the
userguide, removed build and configuration files from the devguide
dir, as these are no longer needed.

Task #4909
3 years ago
..
codebase devguide: move into userguide as last chapter 3 years ago
extending devguide: move into userguide as last chapter 3 years ago
internals devguide: move into userguide as last chapter 3 years ago
tools devguide: move into userguide as last chapter 3 years ago
.gitignore devguide: move into userguide as last chapter 3 years ago
README.md devguide: move into userguide as last chapter 3 years ago
index.rst devguide: move into userguide as last chapter 3 years ago

README.md

Suricata Developer Guide

This directory contains the Suricata Developer Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.

Verifying Changes

There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).

The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.

There are different application dependencies based on the output desired.