From a8ab31155d3400915efe96187ba5ad33e0a4b7b4 Mon Sep 17 00:00:00 2001 From: Antonella Ritorto Date: Thu, 5 Jun 2025 17:56:06 +0200 Subject: [PATCH 1/2] Alternative: doxygen awesome --- .github/workflows/docsWithAw.yml | 78 ++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 .github/workflows/docsWithAw.yml diff --git a/.github/workflows/docsWithAw.yml b/.github/workflows/docsWithAw.yml new file mode 100644 index 000000000..8b1ab8c34 --- /dev/null +++ b/.github/workflows/docsWithAw.yml @@ -0,0 +1,78 @@ +name: Build opm-grid/opm/grid Doxygen Docs and push to gh-pages + +on: + push: + branches: + - '**' + pull_request_target: + types: closed + branches: master + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Install system dependencies + run: | + sudo apt-get update + sudo apt-get install -y doxygen unzip wget + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.11" + + - name: Install Python packages + run: | + python -m pip install --upgrade pip + pip install sphinx==7.1.2 breathe==4.35.0 furo + + - name: Prepare output directory + run: | + mkdir -p docs/doxygen docs/doxygen-awesome-css + + # Download Doxygen Awesome CSS theme assets + - name: Download Doxygen Awesome CSS + run: | + wget -q -O docs/doxygen-awesome-css/doxygen-awesome.css https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@master/doxygen-awesome.css + wget -q -O docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@master/doxygen-awesome-darkmode-toggle.js + wget -q -O docs/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js https://cdn.jsdelivr.net/gh/jothepro/doxygen-awesome-css@master/doxygen-awesome-fragment-copy-button.js + + # Download your custom header.html if you use it + - name: Download custom header.html + run: | + doxygen -w html header.html footer.html stylesheet.css + + # edit header.html if you use it + # - name: Edit header.html ??? + # run: wget -q -O docs/header.html https://your-url.com/header.html + + - name: Create minimal Doxyfile (to be improved) + run: | + rm -f Doxyfile + echo "PROJECT_NAME = "OPM Grid"" >> Doxyfile + echo "OUTPUT_DIRECTORY = docs/doxygen" >> Doxyfile + echo "INPUT = opm/grid/" >> Doxyfile + echo "RECURSIVE = YES" >> Doxyfile + echo "GENERATE_HTML = YES" >> Doxyfile + echo "GENERATE_LATEX = NO" >> Doxyfile + echo "GENERATE_XML = NO" >> Doxyfile + echo "EXTRACT_ALL = YES" >> Doxyfile + echo "HTML_EXTRA_STYLESHEET = docs/doxygen-awesome-css/doxygen-awesome.css" >> Doxyfile + echo "HTML_EXTRA_FILES = docs/doxygen-awesome-css/doxygen-awesome-darkmode-toggle.js \ + docs/doxygen-awesome-css/doxygen-awesome-fragment-copy-button.js" >> Doxyfile + # echo "HTML_HEADER = docs/header.html" >> Doxyfile + + - name: Build Doxygen documentation + run: | + doxygen Doxyfile + + - name: Deploy documentation + uses: OPM/github-pages-deploy-action@releases/v4 + with: + branch: gh-pages + folder: docs/doxygen/html From 0c8e8f9d29286470afc95e1579f5553ea917280e Mon Sep 17 00:00:00 2001 From: Antonella Ritorto Date: Fri, 6 Jun 2025 08:53:12 +0200 Subject: [PATCH 2/2] Add graphviz --- .github/workflows/docsWithAw.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docsWithAw.yml b/.github/workflows/docsWithAw.yml index 8b1ab8c34..a5d5ebb06 100644 --- a/.github/workflows/docsWithAw.yml +++ b/.github/workflows/docsWithAw.yml @@ -19,7 +19,7 @@ jobs: - name: Install system dependencies run: | sudo apt-get update - sudo apt-get install -y doxygen unzip wget + sudo apt-get install -y doxygen graphviz unzip wget - name: Set up Python uses: actions/setup-python@v4