doc: publish autogenerated module api documentation

NO_DOC=internal NO_TEST=internal

doc: publish autogenerated module api documentation
f064175e · Sergey Bronnikov · Igor Munkin · ef434db5 · f064175e · f064175e
Commit f064175e authored 2 years ago by Sergey Bronnikov Committed by Igor Munkin 2 years ago
--- a/.github/workflows/publish-module-api-doc.yaml
+++ b/.github/workflows/publish-module-api-doc.yaml
+name: Publish module API documentation
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  publish-api-doc:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone the module
+        uses: actions/checkout@v2
+
+      - name: Setup Doxygen
+        run: sudo apt install -y doxygen
+
+      - name: Build module API documentation using Doxygen
+        run: |
+            cmake .
+            make module_api
+            sed -e "s%@PROJECT_.\+_DIR@/%%" Doxyfile.API.in > Doxyfile.API
+            doxygen Doxyfile.API
+
+      - name: Publish generated API documentation to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@4.4.0
+        with:
+          folder: doc/
--- a/changelogs/unreleased/publish-doxygen-doc.md
+++ b/changelogs/unreleased/publish-doxygen-doc.md
+## feature/doxygen
+
+* Doxygen API documentation published automatically on every merge to master branch.
--- a/doc/index.html
+++ b/doc/index.html
+<!-- HTML index file used in https://tarantool.github.io/tarantool/ -->
+
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Tarantool Documentation</title>
+  </head>
+  <body>
+    <a href="/api/html/module_8h.html">Module API documentation</a>
+  </body>
+</html>