| 1 | # .readthedocs.yaml |
| 2 | # Read the Docs configuration file |
| 3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
| 4 | |
| 5 | # Required |
| 6 | version: 2 |
| 7 | |
| 8 | build: |
| 9 | os: "ubuntu-24.04" |
| 10 | # apt_packages: |
| 11 | # - libclang1-12 |
| 12 | # - libclang-cpp12 |
| 13 | tools: |
| 14 | python: "3" |
| 15 | commands: |
| 16 | # Install doxygen from source distributions (conda forge does not keep up-to-date doxygen releases) |
| 17 | - > |
| 18 | DOXYGEN_VERSION="1.15.0" && |
| 19 | RELEASE_TITLE=$(echo ${DOXYGEN_VERSION} | tr '.' '_') && |
| 20 | mkdir .doxygen && cd .doxygen && |
| 21 | curl -L "https://github.com/doxygen/doxygen/releases/download/Release_${RELEASE_TITLE}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz" --output doxygen.tar.gz && |
| 22 | gunzip doxygen.tar.gz && |
| 23 | tar xf doxygen.tar && |
| 24 | mv doxygen-$DOXYGEN_VERSION/bin/doxygen ./ |
| 25 | # get lib version & overwrite Doxyfile values |
| 26 | - python3 .github/doxygen.py |
| 27 | # run doxygen |
| 28 | - cd docs && ../.doxygen/doxygen |
| 29 | # copy output to RTD output path for HTML files |
| 30 | - ls -R docs/html/ |
| 31 | - mkdir -p ${READTHEDOCS_OUTPUT} |
| 32 | - mv docs/html/ "${READTHEDOCS_OUTPUT}" |