Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mattnotmitt committed Apr 4, 2020
1 parent 36683ad commit 842268f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
# Doxygen Docker Action
This [GitHub Action](https://github.com/features/actions) will build [doxygen](http://doxygen.nl/) docs according to a specified Doxyfile - if omitted will search in the root directory of the repo.
This [GitHub Action](https://github.com/features/actions) will build [doxygen](http://doxygen.nl/) docs from the specified doxyfile.

Use with an action such as [actions-gh-pages](https://github.com/peaceiris/actions-gh-pages) to deploy to your project's GitHub pages site!

**NOTE:** If you are using dot/graphviz in your doxygen config to generate diagrams the only fonts installed, and hence can be used are those in the [GNU FreeFont](https://www.gnu.org/software/freefont/) package (FreeSans, FreeMono and FreeSerif).

## Inputs
### 'working-directory'
**Required** Path of the working directory to change to before running doxygen. Default: `.`
### 'doxyfile-path'
**Required** Path of the Doxyfile relative to the repository root. Default: `./Doxyfile`.
**Required** Path of the Doxyfile relative to the working directory. Default: `./Doxyfile`.

## Example usage
```yaml
uses: mattnotmitt/doxygen-action@v1
with:
working-directory: 'submodule/'
doxyfile-path: 'docs/Doxygen'
```
```

0 comments on commit 842268f

Please sign in to comment.