diff --git a/.github/workflows/documentation-branch.yml b/.github/workflows/documentation-branch.yml deleted file mode 100644 index 5399bf3f..00000000 --- a/.github/workflows/documentation-branch.yml +++ /dev/null @@ -1,61 +0,0 @@ -# # 'sync' job from: https://stackoverflow.com/questions/76509304/running-github-action-to-keep-a-branch-up-to-date-with-main -# name: Run Documentation Branch - -# on: -# push: -# branches: [main] - -# permissions: -# contents: write - -# jobs: -# # sync: -# # # if: github.ref == 'refs/heads/documentation' -# # runs-on: ubuntu-latest -# # steps: -# # - name: Checkout -# # uses: actions/checkout@v3 -# # with: -# # fetch-depth: 0 - -# # - name: Setup Git User -# # run: | -# # git config user.name "GitHub Action" -# # git config user.email "" - -# # - name: Update Documentation Branch -# # run: | -# # git checkout main -# # git fetch origin -# # git checkout documentation -# # git pull -# # git merge origin/main -# # git push origin documentation - -# build-deploy-documentation: -# # needs: sync -# runs-on: ubuntu-latest -# steps: -# - name: Checkout -# uses: actions/checkout@v3 - -# - name: Build DOxygen documentation -# uses: mattnotmitt/doxygen-action@v1.9.5 -# with: -# doxyfile-path: './backend/Doxyfile' -# working-directory: '.' -# enable-latex: true - -# - name: Build JSDoc documentation -# if: ${{ false }} -# uses: andstor/jsdoc-action@v1 -# with: -# source_dir: './frontend/src/lib' -# recurse: true -# output_dir: './docs/jsdoc' - -# - name: Deploy -# uses: peaceiris/actions-gh-pages@v3 -# with: -# github_token: ${{ secrets.GITHUB_TOKEN }} -# publish_dir: ./generated-docs/html \ No newline at end of file diff --git a/.github/workflows/main.yml b/.github/workflows/generate_documentation.yml similarity index 60% rename from .github/workflows/main.yml rename to .github/workflows/generate_documentation.yml index 04baf429..64669a70 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/generate_documentation.yml @@ -13,11 +13,19 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - - name: Doxygen Action + - name: Build Doxygen documentation uses: mattnotmitt/doxygen-action@v1.9.5 with: doxyfile-path: "./Doxyfile" working-directory: "./backend" + - name: Move Doxygen HTML files into Doxygen directory + run: mv ./docs/doxygen/html ./docs/doxygen + - name: Build JSDoc documentation + uses: andstor/jsdoc-action@v1 + with: + config_file: "./frontend/jsdoc.config.json" + output_dir: './docs/jsdoc' + recurse: true - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: diff --git a/backend/Doxyfile b/backend/Doxyfile index c906f02a..3f01df35 100644 --- a/backend/Doxyfile +++ b/backend/Doxyfile @@ -1930,7 +1930,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = FALSE # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/frontend/jsdoc.config.json b/frontend/jsdoc.config.json index 33e47e18..c4cbb3a6 100644 --- a/frontend/jsdoc.config.json +++ b/frontend/jsdoc.config.json @@ -4,12 +4,12 @@ ], "recurseDepth": 10, "source": { + "include": [ "frontend/src/lib" ], "includePattern": ".+\\.js(doc|x)?$", "excludePattern": "(^|\\/|\\\\)_" }, "sourceType": "module", "tags": { - "include": [ "src/lib" ], "allowUnknownTags": true, "dictionaries": ["jsdoc","closure"] }, diff --git a/frontend/src/lib/index.js b/frontend/src/lib/index.js index 856f2b6c..7ef355a9 100644 --- a/frontend/src/lib/index.js +++ b/frontend/src/lib/index.js @@ -1 +1,7 @@ // place files you want to import through the `$lib` alias in this folder. +/** + * Test Function + */ +function a() { + +} \ No newline at end of file