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