diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 000000000..0ff930fce --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,78 @@ +name: Documentation generation + +on: + push: + branches: + - '*' + pull_request: + branches: + - master + +jobs: + build: + runs-on: ubuntu-latest + defaults: + run: + working-directory: ./docs/doxygen + steps: + - uses: actions/checkout@v4 + + - name: Install Doxygen + run: sudo apt-get update && sudo apt-get install -y doxygen graphviz + + - name: Build Doxygen + run: | + doxygen Doxyfile + + - name: Upload Doxygen Artifact + uses: actions/upload-artifact@v4 + with: + name: doxygen-full + path: ./docs/doxygen/doxygen_build/ + + - name: Cleanup after Doxygen + run: | + mv ./doxygen_build/html ../refcpp + rm -rf ./doxygen_build + + - name: Upload Website Artifact + uses: actions/upload-artifact@v4 + with: + name: website + path: ./docs + + deploy: + #if: github.ref == 'refs/heads/main' + permissions: + id-token: write + contents: read + pages: write + needs: build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Download Artifacts + uses: actions/download-artifact@v4 + with: + name: website + path: ./dist/ + + - name: Introspect + run: | + echo "--- pwd" + pwd + echo "--- ls ./docs/" + ls -latrh ./dist + echo "--- ls ./dist/" + ls -latrh ./dist/ + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: './dist' + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index 0b4376270..2498d6593 100644 --- a/.gitignore +++ b/.gitignore @@ -55,8 +55,7 @@ Makefile /plugins/ # Doxygen generated files -docs/html/* -docs/latex/* +/docs/doxygen_build/* # IDE artifacts *.swp diff --git a/docs/.nojekyll b/docs/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml deleted file mode 100644 index 1e7c9988a..000000000 --- a/docs/.readthedocs.yaml +++ /dev/null @@ -1,41 +0,0 @@ -# Read the Docs configuration file for Sphinx projects -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -# Set the OS, Python version and other tools you might need -build: - os: ubuntu-22.04 - tools: - python: "3.11" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" - -# Build documentation in the "docs/" directory with Sphinx -sphinx: - configuration: docs/conf.py - -# Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf -# - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html - -# python: -# install: - # - requirements: docs/requirements.txt - # - method: pip - # path: . - # extra_requirements: - # - docs - # - method: pip - # path: another/package -# system_packages: true - -# pip install myst-parser diff --git a/docs/Contributing.md b/docs/Contributing.md index 34a84f9a6..a45f1272b 100644 --- a/docs/Contributing.md +++ b/docs/Contributing.md @@ -1,17 +1,3 @@ ---- -title: JANA: Multi-threaded HENP Event Reconstruction ---- - -
Welcome | -Tutorial | -How-to guides | -Principles | -Reference | -
---|