Use Doxygen to generate the API documentation.

 * Integrated Doxygen documentation into Sphinx

Signed-off-by: lns <[email protected]>

.ci-ignore

@@ -0,0 +1,4 @@
+# Codige Code Review ignore
+
+# Prevent Codiga complaining about Sphinx config.py
+doc/conf.py

.github/workflows/build.yml

@@ -34,7 +34,7 @@ jobs:
           ./tests/do-dga.sh
       - name: Generate Coverage Report
         run: |
-          mkdir -p coverage_report/ndpi_coverage_report
+          mkdir -vp coverage_report/ndpi_coverage_report
           lcov --directory . --capture --output-file lcov.info
           genhtml -o coverage_report/ndpi_coverage_report lcov.info
       - uses: actions/upload-artifact@v2
@@ -75,6 +75,39 @@ jobs:
           cd python
           python tests.py
 
+  documentation:
+    name: Documentation (ubuntu-latest)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install Ubuntu Prerequisites
+        run: |
+          sudo apt-get update
+          sudo apt-get install autoconf automake libtool pkg-config gettext flex bison doxygen
+      - name: Configure nDPI library
+        run: |
+          ./autogen.sh --with-only-libndpi
+      - name: Generate Documentation
+        run: |
+          cd doc
+          pip install --upgrade pip
+          pip install -r requirements.txt
+          make html
+          cd ..
+          mkdir -vp doc/_build/ndpi-documentation-upload/ndpi-documentation
+          mv -v doc/_build/html doc/_build/ndpi-documentation-upload/ndpi-documentation/html
+      - uses: actions/upload-artifact@v2
+        with:
+          name: ndpi-documentation
+          path: doc/_build/ndpi-documentation-upload
+          retention-days: 7
+
   test-scripts:
     name: Test Utils (ubuntu-latest)
     runs-on: ubuntu-latest
@@ -334,12 +367,6 @@ jobs:
         run: |
           make dist
           ./utils/verify_dist_tarball.sh
-      - name: Generate documentation
-        if: startsWith(matrix.os, 'ubuntu-latest') && startsWith(matrix.arch, 'x86_64')
-        run: |
-          pip3 install --user sphinxcontrib.swaggerdoc
-          make -C doc text
-          make -C doc html
       - name: Build nDPI [Mingw-w64] (runs only on ubuntu jobs)
         if: startsWith(matrix.os, 'ubuntu') && startsWith(matrix.arch, 'x86_64')
         run: |

Makefile.am

@@ -12,13 +12,13 @@ EXTRA_DIST = README.md README.nDPI README.fuzzer.md CHANGELOG.md CONTRIBUTING.md
 	autogen.sh wireshark windows utils packages \
 	influxdb/Makefile.in influxdb/metric_anomaly.c influxdb/README.txt \
 	rrdtool/Makefile.in rrdtool/README.txt rrdtool/rrd_anomaly.c rrdtool/rrd_similarity.c \
-	doc/api.rst doc/conf.py doc/flow_risks.rst doc/guide/nDPI_QuickStartGuide.pages \
+	doc/requirements.txt doc/conf.py doc/flow_risks.rst doc/guide/nDPI_QuickStartGuide.pages \
 		doc/guide/nDPI_QuickStartGuide.pdf doc/img/logo.png doc/index.rst \
 		doc/Makefile doc/what_is_ndpi.rst \
 	python/DEV_GUIDE.md python/dev_requirements.txt python/ndpi_example.py python/ndpi/__init__.py \
 		python/ndpi/ndpi_build.py python/ndpi/ndpi.py python/README.md \
 		python/requirements.txt python/setup.py python/tests.py \
-	sonar-project.properties .github .lgtm/cpp-queries/packet-payload-integer-arithmetic.ql lgtm.yml
+	sonar-project.properties .github .ci-ignore .lgtm/cpp-queries/packet-payload-integer-arithmetic.ql lgtm.yml
 
 
 changelog:

configure.ac

@@ -297,7 +297,7 @@ dnl>   ADDITIONAL_LIBS="${ADDITIONAL_LIBS} -lcurl"
 dnl>   AC_DEFINE_UNQUOTED(HAVE_CURL, 1, [curl is present])
 dnl> fi
 
-AC_CONFIG_FILES([Makefile example/Makefile example/Makefile.dpdk tests/Makefile tests/unit/Makefile tests/performance/Makefile tests/dga/Makefile rrdtool/Makefile influxdb/Makefile libndpi.pc src/include/ndpi_define.h src/lib/Makefile fuzz/Makefile src/include/ndpi_api.h])
+AC_CONFIG_FILES([Makefile example/Makefile example/Makefile.dpdk tests/Makefile tests/unit/Makefile tests/performance/Makefile tests/dga/Makefile rrdtool/Makefile influxdb/Makefile libndpi.pc src/include/ndpi_define.h src/lib/Makefile fuzz/Makefile src/include/ndpi_api.h doc/Doxyfile.cfg])
 AC_CONFIG_FILES([tests/do.sh], [chmod +x tests/do.sh])
 AC_CONFIG_HEADERS(src/include/ndpi_config.h)
 AC_SUBST(GIT_RELEASE)