diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml new file mode 100644 index 00000000..9e8cfaec --- /dev/null +++ b/.github/workflows/Doxygen.yml @@ -0,0 +1,39 @@ +# This is a basic workflow to help you get started with Actions + +name: Doxygen + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the develop branch + push: + branches: [ develop ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "Doxygen" + + Doxygen: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v4 + + # Runs a single command using the runners shell + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@1.9.8 + with: + doxyfile-path: './Doxyfile' + working-directory: ./Doc + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./Doc/html + diff --git a/Doc/Doxyfile b/Doc/Doxyfile index ec691e6f..f1bd7828 100644 --- a/Doc/Doxyfile +++ b/Doc/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = "Reference Guide" # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. -PROJECT_LOGO = "../Doc/mach3logo.png" +PROJECT_LOGO = "../Doc/mach3logo_small.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is diff --git a/Doc/mach3logo_small.png b/Doc/mach3logo_small.png new file mode 100644 index 00000000..99676f76 Binary files /dev/null and b/Doc/mach3logo_small.png differ diff --git a/README.md b/README.md index b7b833be..6abf1d63 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,10 @@ The framework has also evolved to allow non MCMC modules to interrogate the like [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://github.com/mach3-software/MaCh3/blob/develop/LICENSE.txt) -[![Relase - v1.0.0](https://img.shields.io/badge/Relase-v1.0.0-2ea44f)](https://github.com/mach3-software/MaCh3/releases) +[![Release - v1.0.0](https://img.shields.io/badge/Release-v1.0.0-2ea44f)](https://github.com/mach3-software/MaCh3/releases) [![Code - Documented](https://img.shields.io/badge/Code-Documented-2ea44f)](https://github.com/mach3-software/MaCh3/wiki) +[![Code - Doxygen](https://img.shields.io/badge/Code-Doxygen-2ea44f)](https://mach3-software.github.io/MaCh3/index.html) + ## Famous Plots TODO this should be expanded