wip

Author: Ozaq

.github/workflows/docs.yml

@@ -0,0 +1,80 @@
+name: Publish Documentation to sites.ecmwf.int
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, closed]
+  push:
+    branches:
+      - 'develop'
+      - 'master'
+    tags:
+      - '**'
+jobs:
+  build:
+    if: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' || github.event_name == 'push'}}
+    runs-on: ubuntu-latest
+    outputs:
+      artifact-id: ${{ steps.upload-doc.outputs.artifact-id }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - name: Install python dependencies
+        run: |
+          python -m pip install -r docs/requirements.txt
+      - name: Prepare Doxygen
+        uses: ecmwf/reusable-workflows/setup-doxygen@main
+        with:
+          version: 1.14.0
+      - name: Build doc
+        run: |
+          cd docs
+          make -j html
+      - name: Archive documentation
+        id: upload-doc
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/_build/html
+  preview-publish:
+    if: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}
+    needs: build
+    uses: ecmwf/reusable-workflows/.github/workflows/pr-preview-publish.yml@main
+    with:
+      artifact-id: ${{ needs.build.outputs.artifact-id }}
+      space: docs
+      name: dev-section
+      path: eckit/pull-requests
+      link-text: 🌦️ >> Documentation << 🌦️
+    secrets:
+      sites-token: ${{ secrets.ECMWF_SITES_DOCS_DEV_SECTION_TOKEN }}
+  preview-unpublish:
+    if: ${{ github.event_name == 'pull_request' && github.event.action == 'closed' }}
+    uses: ecmwf/reusable-workflows/.github/workflows/pr-preview-unpublish.yml@main
+    with:
+      space: docs
+      name: dev-section
+      path: eckit/pull-requests
+    secrets:
+      sites-token: ${{ secrets.ECMWF_SITES_DOCS_DEV_SECTION_TOKEN }}
+  publish:
+    if: >-
+      ${{ github.event_name == 'push' && (
+        github.ref_name == 'develop' ||
+        github.ref_name == 'master'  ||
+        github.ref_type == 'tag'
+      ) }}
+    needs: build
+    uses: ecmwf/reusable-workflows/.github/workflows/docs-publish.yml@main
+    with:
+      artifact-id: ${{ needs.build.outputs.artifact-id }}
+      space: docs
+      name: dev-section
+      path: eckit
+      id: ${{ github.ref_name }}
+      softlink: ${{ github.ref_name == 'master'   && 'stable'
+                 || github.ref_name == 'develop' && 'latest' }}
+    secrets:
+      sites-token: ${{ secrets.ECMWF_SITES_DOCS_DEV_SECTION_TOKEN }}

.gitignore

@@ -10,4 +10,5 @@ doc/latex
 .vscode
 .idea
 build/
+_build
 *.ccls-cache

CMakeLists.txt

@@ -371,7 +371,7 @@ set( PERSISTENT_NAMESPACE "eckit" CACHE INTERNAL "" ) # needed for generating .b
 
 add_subdirectory( src )
 add_subdirectory( bamboo )
-add_subdirectory( doc )
+#add_subdirectory( docs )
 add_subdirectory( share )
 add_subdirectory( tests )
 add_subdirectory( regressions )

docs/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 120
+extend-ignore = E203

doc/CMakeLists.txt renamed to docs/CMakeLists.txt

@@ -5,13 +5,12 @@ ecbuild_add_option(
 
 if( HAVE_DOCS )
 
-  set( ECKIT_DOC eckit_doc )
+  set( ECKIT_DOC eckit-doc )
   if( PROJECT_NAME STREQUAL CMAKE_PROJECT_NAME )
     set( ECKIT_DOC doc )
   endif()
 
   set( DOXYFILE Doxyfile CACHE INTERNAL "Doxygen filename" )
-  configure_file(${CMAKE_CURRENT_SOURCE_DIR}/${DOXYFILE}.in "${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}" @ONLY )
   add_custom_target( ${ECKIT_DOC}
   COMMAND doxygen ${CMAKE_CURRENT_BINARY_DIR}/${DOXYFILE}
   WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} )