Skip to content

Commit

Permalink
Add info on new features to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ammaraskar committed Dec 24, 2019
1 parent bbd4951 commit 2e99655
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,25 @@ If you wish to customize the command used to build the docs (defaults to
example, to invoke sphinx-build directly you can use:

```yaml
- uses: ammaraskar/sphinx-action@master
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
build-command: "sphinx-build -b html . _build"
args: "docs/"
```

If there's system level dependencies that need to be installed for your
build, you can use the `pre-build-command` argument like so:

```yaml
- uses: ammaraskar/sphinx-action@master
with:
repo-token: "${{ secrets.GITHUB_TOKEN }}"
pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended"
build-command: "make latexpdf"
args: "docs2/"
```

## Running the tests

`python -m unittest`
3 changes: 2 additions & 1 deletion action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ inputs:
pre-build-command:
description:
Run before the build command, you can use this to install system level
dependencies.
dependencies, for example with
"apt-get update -y && apt-get install -y perl"
required: false
runs:
using: 'docker'
Expand Down

0 comments on commit 2e99655

Please sign in to comment.