Skip to content

Commit c5c1050

Browse files
authored
docs: use quartodoc build for cli instructions
1 parent 7e5fb18 commit c5c1050

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/get-started/overview.qmd

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ quartodoc:
5757
Next, run this command to generate your API pages:
5858
5959
```bash
60-
python -m quartodoc build
60+
quartodoc build
6161
```
6262

6363
This should create a `reference/` directory with an `index.qmd` and documentation
@@ -74,7 +74,7 @@ quarto preview
7474
As mentioned in the previous section, you can preview your quartodoc site using these commands:
7575

7676
```bash
77-
python -m quartodoc build
77+
quartodoc build
7878
quarto preview
7979
```
8080

@@ -84,7 +84,7 @@ the quartodoc build command:
8484
```bash
8585
# with quarto preview running, you only need to re-run quartodoc build,
8686
# which will re-create the pages of your API documentation.
87-
python -m quartodoc build
87+
quartodoc build
8888
```
8989

9090
## Looking up objects
@@ -141,4 +141,4 @@ The functions listed in `contents` are assumed to be imported from the package.
141141
[vetiver]: https://rstudio.github.io/vetiver-python/stable/reference/
142142
[vt-code]: https://github.com/rstudio/vetiver-python
143143
[siuba]: https://siuba.org/api/
144-
[sb-code]: https://github.com/machow/siuba.org
144+
[sb-code]: https://github.com/machow/siuba.org

0 commit comments

Comments
 (0)