Skip to content

Commit 673d14e

Browse files
Update build-sphinx-docs/README.md
Co-authored-by: Andrew Coughtrie <24609575+andrewcoughtrie@users.noreply.github.com>
1 parent 2876d2c commit 673d14e

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

build-sphinx-docs/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ documentation from a local repository to GitHub Pages.
55

66
## Usage
77

8-
To use this workflow developers must have a `requirements.txt` file in the top
9-
level of their project repository to outline the sphinx dependencies that will
10-
be used by the `build-sphinx-docs` workflow. An example of a `requirements.txt`
8+
To use this workflow developers must have a `requirements.txt` file to define
9+
the sphinx dependencies that will be used by the `build-sphinx-docs` workflow.
10+
By default the workflow will look for a `requirements.txt` file in the top
11+
level of the calling project repository. An example of a `requirements.txt`
1112
file which could run this workflow would be as follows:
1213

1314
### Example requirements

0 commit comments

Comments
 (0)