From d30fbc04da1d6eb8d530da07feb3fa62cc3cdb6c Mon Sep 17 00:00:00 2001 From: Richard Gill Date: Mon, 18 Nov 2024 00:50:51 +0100 Subject: [PATCH 1/5] added gh-pages action to deploy doxygen generated doc --- .github/workflows/docs.yml | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 000000000..87023c2e6 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,26 @@ +name: Documentation on github.io + +on: + push: + branches: [ github.io ] + +jobs: + build-documentation: + runs-on: ubuntu-latest + steps: + - name: checkout + uses: actions/checkout@v4 + - name: apt-update + run: sudo apt-get update -qq + - name: apt-get doxygen + run: sudo apt-get install -y doxygen + - name: build doc + run: make docs + - name: deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./docs/html/ + enable_jekyll: false + allow_empty_commit: false + force_orphan: true From 16327f8946e2fb905b54acb45d4de0d9705c72e3 Mon Sep 17 00:00:00 2001 From: Richard Gill Date: Mon, 18 Nov 2024 01:03:55 +0100 Subject: [PATCH 2/5] fixed doc path for deployment --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 87023c2e6..b3e409063 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,10 +17,10 @@ jobs: - name: build doc run: make docs - name: deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./docs/html/ + publish_dir: ./doc/html/ enable_jekyll: false allow_empty_commit: false force_orphan: true From 34bf5834d274be5b922f6cfd5d5c51033aee6b5e Mon Sep 17 00:00:00 2001 From: Richard Gill Date: Mon, 18 Nov 2024 01:16:23 +0100 Subject: [PATCH 3/5] removed REAMDE.me from pages --- Readme.md | 2 +- doc/Doxyfile | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/Readme.md b/Readme.md index 49bd320ee..e535a5ec7 100644 --- a/Readme.md +++ b/Readme.md @@ -25,7 +25,7 @@ render backends, it focuses only on the actual UI. - No global or hidden state - Customizable library modules (you can compile and use only what you need) - Optional font baker and vertex buffer output -- [Documentation](https://Immediate-Mode-UI.github.io/Nuklear/doc/nuklear.html) +- [Documentation](https://Immediate-Mode-UI.github.io/Nuklear/) ## Building diff --git a/doc/Doxyfile b/doc/Doxyfile index 049530a1c..c61c5c9c6 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -907,8 +907,7 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = "./src" \ - "./src/HEADER.md" \ - "./Readme.md" + "./src/HEADER.md" @@ -1001,7 +1000,7 @@ RECURSIVE = NO EXCLUDE = "./src/Readme.md" \ "./src/paq.sh" \ - "./src/paq.bat" + "./src/paq.bat" # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded From 8778b896358c24e4fbc2252b4d1b27dbe4b63d9c Mon Sep 17 00:00:00 2001 From: Richard Gill Date: Mon, 18 Nov 2024 01:23:42 +0100 Subject: [PATCH 4/5] fixed main page (from src/HEADER.md) --- doc/Doxyfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index c61c5c9c6..003d71a87 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1109,7 +1109,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = Readme.md +USE_MDFILE_AS_MAINPAGE = src/HEADER.md #--------------------------------------------------------------------------- # Configuration options related to source browsing From 89b269101b9970f9a1d857d7f4b828d633e839d2 Mon Sep 17 00:00:00 2001 From: Richard Gill Date: Mon, 18 Nov 2024 01:36:59 +0100 Subject: [PATCH 5/5] changed the action to run on master branch --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index b3e409063..bcb5701e4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,7 +2,7 @@ name: Documentation on github.io on: push: - branches: [ github.io ] + branches: [ master ] jobs: build-documentation: