Skip to content

Commit bd0507a

Browse files
committed
docs: ignore generated CLI docs lint warning, also regenerate doc
1 parent 89dc8c2 commit bd0507a

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

dev/generate_cli_docs.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,11 @@ def generate_command_docs(cmd: click.Group) -> str:
194194

195195
markdown_content = []
196196

197+
# Disable lint warnings for about "first line in file should be a top level heading"
198+
# We intentionally start with a level 2 heading below, as this file is imported into another file.
199+
markdown_content.append("<!-- markdownlint-disable MD041 -->")
200+
markdown_content.append("")
201+
197202
# Add top-level heading to satisfy MD041 linting rule
198203
markdown_content.append("## Subcommands Reference")
199204
markdown_content.append("")

docs/docs/core/cli-commands.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
<!-- markdownlint-disable MD041 -->
2+
13
## Subcommands Reference
24

35
### `drop`
@@ -115,6 +117,7 @@ cocoindex server [OPTIONS] APP_TARGET
115117
| `-cl, --cors-local INTEGER` | Allow `http://localhost:<port>` to access the server. |
116118
| `-L, --live-update` | Continuously watch changes from data sources and apply to the target index. |
117119
| `--setup` | Automatically setup backends for the flow if it's not setup yet. |
120+
| `--reset` | Drop existing setup before starting server (equivalent to running 'cocoindex drop' first). |
118121
| `--reexport` | Reexport to targets even if there's no change. |
119122
| `-f, --force` | Force setup without confirmation prompts. |
120123
| `-q, --quiet` | Avoid printing anything to the standard output, e.g. statistics. |
@@ -142,6 +145,7 @@ cocoindex setup [OPTIONS] APP_TARGET
142145
| Option | Description |
143146
|--------|-------------|
144147
| `-f, --force` | Force setup without confirmation prompts. |
148+
| `--reset` | Drop existing setup before running setup (equivalent to running 'cocoindex drop' first). |
145149
| `--help` | Show this message and exit. |
146150

147151
---
@@ -203,6 +207,7 @@ cocoindex update [OPTIONS] APP_FLOW_SPECIFIER
203207
| `-L, --live` | Continuously watch changes from data sources and apply to the target index. |
204208
| `--reexport` | Reexport to targets even if there's no change. |
205209
| `--setup` | Automatically setup backends for the flow if it's not setup yet. |
210+
| `--reset` | Drop existing setup before updating (equivalent to running 'cocoindex drop' first). |
206211
| `-f, --force` | Force setup without confirmation prompts. |
207212
| `-q, --quiet` | Avoid printing anything to the standard output, e.g. statistics. |
208213
| `--help` | Show this message and exit. |

0 commit comments

Comments
 (0)