Skip to content

Commit

Permalink
Made generate_documentation.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
Chi-EEE committed Oct 7, 2023
1 parent 1d617db commit 663e709
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 64 deletions.
61 changes: 0 additions & 61 deletions .github/workflows/documentation-branch.yml

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,19 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Doxygen Action
- name: Build Doxygen documentation
uses: mattnotmitt/[email protected]
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:
Expand Down
2 changes: 1 addition & 1 deletion backend/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion frontend/jsdoc.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
},
Expand Down
6 changes: 6 additions & 0 deletions frontend/src/lib/index.js
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
// place files you want to import through the `$lib` alias in this folder.
/**
* Test Function
*/
function a() {

}

0 comments on commit 663e709

Please sign in to comment.