Skip to content
Snippets Groups Projects
Commit 67836dca authored by Nicki Křížek's avatar Nicki Křížek
Browse files

Merge branch 'docs-movearound' into 'master'

Move docs build instructions out of README.md

See merge request !83
parents 290a0b82 4cc60029
Branches
Tags
1 merge request!83Move docs build instructions out of README.md
Pipeline #118250 passed with stage
in 14 seconds
......@@ -39,22 +39,10 @@ The toolchain also provides scripts that can plot these into readable charts.
**The latest documentation can be found at <https://dns-shotgun.readthedocs.io/>.**
To display the documentation with local changes, [install
MkDocs](https://www.mkdocs.org/user-guide/installation/), then build:
```
$ mkdocs build
```
This will create a new `site` directory containing the Shotgun documentation in
HTML format.
For testing the locally built documentation with live-rebuild, you can use
MkDocs' built-in development server:
```
$ mkdocs serve
```
For installation and/or build instructions, see the
[Installation section](https://dns-shotgun.readthedocs.io/en/stable/installation.html)
of the documentation. The same section also contains instructions for building
the documentation itself.
## Showcase
......
......@@ -62,3 +62,28 @@ and compiling the dnssim module isn't required.
- Python 3.6 or later
- Python dependencies from [requirements.txt](https://gitlab.nic.cz/knot/shotgun/-/blob/master/requirements.txt)
- (optional) tshark/wireshark for some PCAP pre-processing
## Documentation
**The latest documentation can be found at
<https://dns-shotgun.readthedocs.io/>** &mdash; chances are that is what you are
looking at right now. The documentation is also available in human-readable
Markdown files in the source tree's `docs` subdirectory.
You may wish to edit the documentation locally and preview those local changes.
To do that, [install MkDocs](https://www.mkdocs.org/user-guide/installation/),
then, in the sources directory, run:
```
$ mkdocs build
```
This will create a new `site` directory containing the Shotgun documentation in
HTML format.
For testing the locally built documentation with live-rebuild, MkDocs' built-in
development server may be used like so:
```
$ mkdocs serve
```
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment