From 4209ac8fa33f2db90148056a9c7bf010b0de0b1b Mon Sep 17 00:00:00 2001 From: tanner-andrulis Date: Thu, 5 Sep 2024 09:31:52 -0400 Subject: [PATCH] Auto documentation --- .github/workflows/main.yml | 43 ++++++++++++++++++++++++++++++++++++++ Doxyfile | 6 +++--- 2 files changed, 46 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..a98bf54 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,43 @@ +# This is a basic workflow to help you get started with Actions + +name: Doxygen Action + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the main branch +on: + push: + branches: [ main ] + + + +# 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 "build" + build: + # 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@v2 + + # Install doxpypy + - name: Install doxypypy + run: pip install doxypypy + + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@v1.1.0 + with: + # Path to Doxyfile + doxyfile-path: "./Doxyfile" # default is ./Doxyfile + # Working directory + working-directory: "." # default is . + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + # Default Doxyfile build documentation to html directory. + # Change the directory if changes in Doxyfile + publish_dir: ./html \ No newline at end of file diff --git a/Doxyfile b/Doxyfile index 53a4b55..8fc5544 100644 --- a/Doxyfile +++ b/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "TimeloopFE" +PROJECT_NAME = "PyTimeloop" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -864,7 +864,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = README.md timeloopfe/v4 timeloopfe/common +INPUT = README.md pytimeloop/timeloopfe/v4 pytimeloop/timeloopfe/common # 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 @@ -2236,7 +2236,7 @@ SEARCH_INCLUDES = YES # preprocessor. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = timeloopfe timeloopfe/v3 timeloopfe/v4 timeloopfe/common +INCLUDE_PATH = timeloopfe pytimeloop/timeloopfe/v3 pytimeloop/timeloopfe/v4 pytimeloop/timeloopfe/common # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the