Skip to content

Commit 57fa1e2

Browse files
Update build-sphinx-docs/README.md
I think this section can be expanded like a man page, maybe in a separate PR. Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
1 parent 46f42d6 commit 57fa1e2

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

build-sphinx-docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,11 @@ jobs:
9090
uses: MetOffice/growss/.github/workflows/build-sphinx-docs.yaml@main
9191
with:
9292
requirements: /path/to/requirements.txt
93-
# runner: ubuntu-24.04
94-
# timeout: 10
95-
# docs-directory: '/path/to/documentation'
96-
# sphinx-opts: 'extra options'
97-
# build-directory: '/path/to/build/html'
93+
runner: ubuntu-24.04
94+
timeout: 10
95+
docs-directory: '/path/to/documentation'
96+
sphinx-opts: 'extra options'
97+
build-directory: '/path/to/build/html'
9898
9999
deploy-docs:
100100
if: github.ref == 'refs/heads/main'

0 commit comments

Comments
 (0)