diff --git a/README.md b/README.md index 240734e6..75074634 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,7 @@ jobs: - `github_token` (required): GitHub token for pushing to repo. See the [docs](https://git.io/passing-token) for more info. - `branch` (optional): Branch to deploy to. Defaults to `gh-pages`. - `folder` (optional): Folder where the docs are built. Defaults to `docs/html`. +- `config_file` (optional): Path of the Doxygen configuration file. Defaults to `Doxyfile`. ## Advanced Usage @@ -51,6 +52,7 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} branch: gh-pages folder: docs/html + config_file: Doxyfile ``` ## About this Action @@ -71,10 +73,12 @@ sudo apt-get install doxygen -y ### 3. Generate Doxygen Documentation -Doxygen documentation is generated by running the following command: +Doxygen documentation is generated by running the following command. + +Set the `config_file` input option to change `Doxyfile` to a different filename. ```bash -doxygen +doxygen Doxyfile ``` ### 4. Create .nojekyll diff --git a/action.yml b/action.yml index d0a65efe..87edef84 100644 --- a/action.yml +++ b/action.yml @@ -17,6 +17,10 @@ inputs: description: 'Folder where Doxygen will generate the HTML build files' required: true default: "docs/html" + config_file: + description: 'Path of the Doxygen configuration file' + required: true + default: "Doxyfile" runs: using: "composite" @@ -31,7 +35,7 @@ runs: shell: bash - name: Generate Doxygen Documentation - run: doxygen + run: doxygen ${{ inputs.config_file }} shell: bash - name: Create .nojekyll (ensures pages with underscores work on gh pages)