DEV,PKG: Update debian rules, travis

and add changelog entry for the PR

Author: Sebastian Wagner

.travis.yml

@@ -15,6 +15,8 @@ jobs:
     env: mode=debian
   - python: 3.8
     env: mode=codestyle
+  - python: 3.8
+    env: mode=documentation
 before_install:
   - if [[ -v requirements ]]; then curl -s -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.6.1-amd64.deb; fi
   - if [[ -v requirements ]]; then sudo dpkg -i --force-confnew elasticsearch-7.6.1-amd64.deb; fi
@@ -30,9 +32,9 @@ install:
   - if [[ -v requirements ]]; then pip install Cerberus!=1.3 codecov pyyaml requests_mock; fi
   - if [[ $mode == codestyle ]]; then pip install pycodestyle; fi
   - if [[ -v requirements ]]; then sudo sed -i '/^Defaults\tsecure_path.*$/ d' /etc/sudoers; fi
-  - if [[ $TRAVIS_PYTHON_VERSION < '3.6' ]]; then rm intelmq/bin/intelmq_gen_docs.py intelmq/tests/bin/test_gen_docs.py; fi  # file requires Python 3.6
   - if [[ -v requirements ]]; then sudo pip install .; fi
   - if [[ -v requirements ]]; then sudo intelmqsetup --skip-ownership; fi
+  - if [[ $mode == documentation ]]; then pip install -r docs/requirements.txt; fi
 before_script:
   - if [[ $requirements == true ]] ; then psql -c "CREATE USER intelmq WITH SUPERUSER" -U postgres; fi
   - if [[ $requirements == true ]] ; then psql -c "CREATE DATABASE intelmq" -U intelmq template1; fi
@@ -57,6 +59,9 @@ script:
   - if [[ $mode == debian ]]; then pushd ../build; fi
   - if [[ $mode == debian ]]; then DEB_BUILD_OPTIONS='nocheck' dpkg-buildpackage -us -uc -d; fi
   - if [[ $mode == debian ]]; then popd; fi
+  - if [[ $mode == documentation ]]; then pushd docs; fi
+  - if [[ $mode == documentation ]]; then make html; fi
+  - if [[ $mode == documentation ]]; then popd; fi
 services:
   - redis
   - postgresql

CHANGELOG.md

@@ -79,6 +79,7 @@ CHANGELOG
   - Updated documentation for Maxmind GeoIP, ASN Lookup, TOR Nodes and Recorded Future experts to reflect new `--update-database` option.  (PR#1524 by Filip Pokorný)
 - Add n6 Integration documentation.
 - Moved 'Orphaned Queues' section from the FAQ to the intelmqctl documentation.
+- Generate documentation using Sphinx (PR#1622 by Birger Schacht).
 
 ### Packaging
 

debian/rules

@@ -32,9 +32,8 @@ override_dh_auto_build:
 
 override_dh_auto_install: $(BOTDOCS)
 	rm intelmq/bin/rewrite_config_files.py
-	rm intelmq/bin/intelmq_gen_docs.py intelmq/tests/bin/test_gen_docs.py
 	sed -i -e '/#!\/usr\/bin\//d' intelmq/bin/*.py
-	sed -i -f debian/sedfile intelmq/bots/BOTS intelmq/etc/* docs/intelmqctl.md docs/Bots.md setup.py contrib/logrotate/intelmq
+	sed -i -f debian/sedfile intelmq/bots/BOTS intelmq/etc/* docs/guides/intelmqctl.md docs/guides/Bots.md setup.py contrib/logrotate/intelmq
 	python3 setup.py install --root=debian/intelmq --prefix=/usr
 	# these are already in /usr/bin/
 	#rm %{buildroot}/%{python3_sitelib}/intelmq/bots/experts/maxmind_geoip/update-geoip-data