Skip to content

Commit f6267c5

Browse files
committed
docs: add banner linking to docs folder
1 parent 2d76285 commit f6267c5

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/get-started/overview.qmd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ jupyter:
77
name: python3
88
---
99

10+
::: {.callout-warning}
11+
quartodoc is work in progress! For a basic implementation, take a look at the [docs folder](https://github.com/machow/quartodoc/tree/main/docs) for this site,
12+
including [this script](https://github.com/machow/quartodoc/blob/main/docs/1_generate_api.py) used to generate API pages.
13+
:::
14+
1015
Coming soon!
1116

1217
## Goals

docs/index.qmd

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
title: "quartodoc"
33
---
44

5+
::: {.callout-warning}
6+
quartodoc is work in progress! For a basic implementation, take a look at the [docs folder](https://github.com/machow/quartodoc/tree/main/docs) for this site,
7+
including [this script](https://github.com/machow/quartodoc/blob/main/docs/1_generate_api.py) used to generate API pages.
8+
:::
9+
510
For users:
611

712
* Read and interact with docstrings.

0 commit comments

Comments
 (0)