diff --git a/Doxyfile b/.github/Doxyfile similarity index 99% rename from Doxyfile rename to .github/Doxyfile index 19b73f8..fb496cc 100644 --- a/Doxyfile +++ b/.github/Doxyfile @@ -328,7 +328,7 @@ OPTIMIZE_OUTPUT_SLICE = NO # # Note see also the list of default file extension mappings. -EXTENSION_MAPPING = +EXTENSION_MAPPING = txt=md # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable @@ -865,6 +865,8 @@ WARN_LOGFILE = # Note: If this tag is empty the current directory is searched. INPUT = ./ +INPUT += ./README.md +USE_MDFILE_AS_MAINPAGE = ./README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses diff --git a/.github/workflows/doxygen-doc.yml b/.github/workflows/doxygen-doc.yml new file mode 100644 index 0000000..6be2d8e --- /dev/null +++ b/.github/workflows/doxygen-doc.yml @@ -0,0 +1,23 @@ +name: Doxygen Deployment + +on: + pull_request: + branches: + - rolling + push: + branches: + - rolling + schedule: + - cron: '0 0 * * 6' + +jobs: + doxygen_generation: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Generate Doxygen for cs4home + uses: mattnotmitt/doxygen-action@edge + with: + doxyfile-path: ".github/Doxyfile"