Skip to content

Commit

Permalink
[CI][DOC] Fix incorrect commands in docs/readme.md (#11583)
Browse files Browse the repository at this point in the history
Fix incorrect commands in docs/readme.md
  • Loading branch information
huajsj authored Jun 6, 2022
1 parent 8038987 commit 283542f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,14 @@ the path that matches the regular expression pattern.
For example, to only build tutorials under `/vta/tutorials`, run

```bash
python tests/scripts/ci.py docs --tutorials=/vta/tutorials
python tests/scripts/ci.py docs --tutorial-pattern=/vta/tutorials
```

To only build one specific file, do

```bash
# The slash \ is used to get . in regular expression
python tests/scripts/ci.py docs --tutorials=file_name\.py
python tests/scripts/ci.py docs --tutorial-pattern=file_name\.py
```

## Helper Scripts
Expand All @@ -95,14 +95,14 @@ You can run the following script to reproduce the CI sphinx pre-check stage.
This script skips the tutorial executions and is useful to quickly check the content.

```bash
python tests/scripts/ci.py docs --precheck
tests/scripts/task_python_docs.sh
```

The following script runs the full build which includes tutorial executions.
You will need a GPU CI environment.

```bash
python tests/scripts/ci.py --precheck --full
python tests/scripts/ci.py docs --full
```

## Define the Order of Tutorials
Expand Down

0 comments on commit 283542f

Please sign in to comment.