Skip to content

Commit

Permalink
docs: add a note on docs preview
Browse files Browse the repository at this point in the history
  • Loading branch information
chloeh13q committed Jul 12, 2024
1 parent 8862979 commit 1712330
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/contribute/01_environment.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,15 @@ just docs-preview

to build and serve the documentation.

::: {.callout-tip}
If you're getting reference errors (e.g., `reference/operations.qmd` not found), you may need to run
```bash
just docs-api-preview
```
which first generates the API docs and then spins up the preview.
:::
[^conda-callout]: Some optional dependencies for Windows and Mac OS are not available through `conda`/`mamba`
[^supported]: Tested in CI. If this doesn't work for you, please [file an issue](https://github.com/ibis-project/ibis/issues/new).
[^m1]: Not working as of March 2024. See https://github.com/ibis-project/ibis/issues/8696
Expand Down

0 comments on commit 1712330

Please sign in to comment.