Skip to content

Commit 769f525

Browse files
committed
mention quarto install explicitly
1 parent 0752db0 commit 769f525

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ git fetch --tags upstream
5858
Then install:
5959

6060
```sh
61-
pip install -e ".[dev,test]"
61+
pip install -e ".[dev,test,doc]"
6262
```
6363

6464
Additionally, you can install pre-commit hooks which will automatically reformat and lint the code when you make a commit:
@@ -78,3 +78,5 @@ make check-types
7878
make check-lint
7979
make check-format
8080
```
81+
82+
See the [docs README](docs/README.md) for instructions on building the documentation locally.

docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This directory contains files to generate Shiny for Python API documentation, us
55

66
## Building the docs
77

8-
To build the docs, first install the Python dependencies and Quarto extensions:
8+
To build the docs, first [download and install Quarto](https://quarto.org/docs/get-started/), and then install the Python dependencies and Quarto extensions:
99

1010
```bash
1111
# Install build dependencies
@@ -22,6 +22,7 @@ Then build the web site using Quarto:
2222

2323
```bash
2424
make site
25+
# When this completes, the docs will be available at _site/index.html.
2526
```
2627

2728
Alternatively, running `make serve` will build the docs, and serve them locally, and watch for changes to the .qmd files:

0 commit comments

Comments
 (0)