From f064175eac7a813769d033e30023919d0539d34a Mon Sep 17 00:00:00 2001 From: Sergey Bronnikov <sergeyb@tarantool.org> Date: Wed, 25 May 2022 13:48:03 +0300 Subject: [PATCH] doc: publish autogenerated module api documentation NO_DOC=internal NO_TEST=internal --- .github/workflows/publish-module-api-doc.yaml | 27 +++++++++++++++++++ changelogs/unreleased/publish-doxygen-doc.md | 3 +++ doc/index.html | 12 +++++++++ 3 files changed, 42 insertions(+) create mode 100644 .github/workflows/publish-module-api-doc.yaml create mode 100644 changelogs/unreleased/publish-doxygen-doc.md create mode 100644 doc/index.html diff --git a/.github/workflows/publish-module-api-doc.yaml b/.github/workflows/publish-module-api-doc.yaml new file mode 100644 index 0000000000..cc2c46fd73 --- /dev/null +++ b/.github/workflows/publish-module-api-doc.yaml @@ -0,0 +1,27 @@ +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/ diff --git a/changelogs/unreleased/publish-doxygen-doc.md b/changelogs/unreleased/publish-doxygen-doc.md new file mode 100644 index 0000000000..27f69b996c --- /dev/null +++ b/changelogs/unreleased/publish-doxygen-doc.md @@ -0,0 +1,3 @@ +## feature/doxygen + +* Doxygen API documentation published automatically on every merge to master branch. diff --git a/doc/index.html b/doc/index.html new file mode 100644 index 0000000000..3e0ddd8ee5 --- /dev/null +++ b/doc/index.html @@ -0,0 +1,12 @@ +<!-- 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> -- GitLab