Skip to content

feat: Add option to specify config file path #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 1, 2022
Merged

feat: Add option to specify config file path #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
283a5c8
feat: Add option to specify config file path
DenverCoder1 May 1, 2022
4595c2a
docs: Update docs to include config_file
DenverCoder1 May 1, 2022
2a9d227
docs: Change text to say filename
DenverCoder1 May 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -51,6 +52,7 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages
folder: docs/html
config_file: Doxyfile
```

## About this Action
Expand All @@ -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
Expand Down
6 changes: 5 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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)
Expand Down