Skip to content

Commit 72c8e4c

Browse files
author
Sebastian Wagner
committed
DOC: Update dev guide on new docs generation
1 parent 6eb7a08 commit 72c8e4c

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

docs/guides/Developers-Guide.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@
5252
- [Tests](#tests)
5353
- [Configuration](#configuration)
5454
- [Cache](#cache)
55-
- [Feeds documentation](#feeds-documentation)
55+
- [Documentation](#documentation)
56+
- [Feeds documentation](#feeds-documentation)
5657
- [Testing Pre-releases](#testing-pre-releases)
5758
- [Installation](#installation)
5859

@@ -731,11 +732,27 @@ The databases `<` 10 are reserved for the IntelMQ core:
731732
* 3: statistics
732733
* 4: tests
733734
734-
## Feeds documentation
735+
## Documentation
735736
736-
The feeds which are known to be working with IntelMQ are documented in the machine-readable file `intelmq/etc/feeds.yaml`. The human-readable documentation is in `docs/Feeds.md`. In order to keep these files in sync, call `intelmq/bin/intelmq_gen_docs.py` which generates the Markdown file from the YAML file.
737+
To build the documentation you need three packages:
738+
- Sphinx
739+
- ReCommonMark
740+
- `sphinx-markdown-tables`
737741
738-
So to add a new feeds, change the `feeds.yaml` and then call the `intelmq_gen_docs.py` file.
742+
To install them, you can use pip:
743+
```bash
744+
pip3 install -r docs/requirements.txt
745+
```
746+
747+
Then use the Makefile to build the documentation using Sphinx:
748+
```bash
749+
cd docs
750+
make html
751+
```
752+
753+
### Feeds documentation
754+
755+
The feeds which are known to be working with IntelMQ are documented in the machine-readable file `intelmq/etc/feeds.yaml`. The human-readable documentation is in generated with the Sphinx build as described in the previous section.
739756
740757
## Testing Pre-releases
741758

0 commit comments

Comments
 (0)