There was an error while loading. Please reload this page.
1 parent 2876d2c commit 673d14eCopy full SHA for 673d14e
1 file changed
build-sphinx-docs/README.md
@@ -5,9 +5,10 @@ documentation from a local repository to GitHub Pages.
5
6
## Usage
7
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`
+To use this workflow developers must have a `requirements.txt` file to define
+the sphinx dependencies that will be used by the `build-sphinx-docs` workflow.
+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`
12
file which could run this workflow would be as follows:
13
14
### Example requirements
0 commit comments