Skip to content

docs: ignore generated CLI docs lint warning, also regenerate doc #1107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2025
Merged

docs: ignore generated CLI docs lint warning, also regenerate doc #1107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions dev/generate_cli_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,11 @@ def generate_command_docs(cmd: click.Group) -> str:

markdown_content = []

# Disable lint warnings for about "first line in file should be a top level heading"
# We intentionally start with a level 2 heading below, as this file is imported into another file.
markdown_content.append("<!-- markdownlint-disable MD041 -->")
markdown_content.append("")

# Add top-level heading to satisfy MD041 linting rule
markdown_content.append("## Subcommands Reference")
markdown_content.append("")
Expand Down
5 changes: 5 additions & 0 deletions docs/docs/core/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- markdownlint-disable MD041 -->

## Subcommands Reference

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

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