|
|
|
@ -5,16 +5,10 @@ This directory contains the Suricata Guide. The
|
|
|
|
documentation. For a primer os reStructuredText see the
|
|
|
|
documentation. For a primer os reStructuredText see the
|
|
|
|
[reStructuredText Primer](http://sphinx-doc.org/rest.html).
|
|
|
|
[reStructuredText Primer](http://sphinx-doc.org/rest.html).
|
|
|
|
|
|
|
|
|
|
|
|
## Development Server
|
|
|
|
## Verifying Changes
|
|
|
|
|
|
|
|
|
|
|
|
To help with writing documentation there is a development web server
|
|
|
|
There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).
|
|
|
|
with live reload. To get run the live server you will first need npm
|
|
|
|
|
|
|
|
installed then run the following:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
npm install
|
|
|
|
The documentation source can be built with `make -f Makefile.sphinx html`. Substitute the 'html' word for desired output format.
|
|
|
|
gulp serve
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Then point your browser at http://localhost:8000/_build/html/index.html
|
|
|
|
There are different application dependencies based on the output desired.
|
|
|
|
|
|
|
|
|
|
|
|
Any edits to .rst files should trigger a "make html" and cause your
|
|
|
|
|
|
|
|
browser to refresh.
|
|
|
|
|
|
|
|
|
jason taylor
8 years ago
committed by
Victor Julien