search

certtools / intelmq

IntelMQ is a solution for IT security teams for collecting and processing security feeds using a message queuing protocol.
https://docs.intelmq.org/latest/
GNU Affero General Public License v3.0
976 stars 297 forks source link

ignore user-generated docs files #2479

Closed sebix closed 4 months ago

sebix commented 8 months ago

and remove already committed files from the tree

gethvi commented 8 months ago

Thanks!

There is one more step necessary: in the github action (build-docs.yaml) we need to generate these two files (by running scripts/generate-event-docs.py and scripts/generate-feeds-docs.py) before building the docs.

This will require ruamel.yaml installed.

sebix commented 5 months ago

There is one more step necessary: in the github action (build-docs.yaml) we need to generate these two files (by running scripts/generate-event-docs.py and scripts/generate-feeds-docs.py) before building the docs.

I expected that the docs build would fail if files were missing, but apparently, mkdocs does not complain about that. Thanks for noticing this, I added this step to the workflow file.