Skip to content

fix: name the Typer apps Typer cannot convert when no command is found - #630

Open
has2k1 wants to merge 2 commits into
fix/script-module-discoveryfrom
fix/build-path-handlers
Open

has2k1 wants to merge 2 commits into
fix/script-module-discoveryfrom
fix/build-path-handlers

Conversation

@has2k1

@has2k1 has2k1 commented Nov 6, 2026

Copy link
Copy Markdown
Collaborator

When CLI discovery finds no command and Typer could not convert an app it met, for example because a parameter has a type Typer does not support, the build now warns and names each such app with Typer's error. Before, the error was hidden and discovery reported only that it found no command, so the author had no hint why the site had no CLI pages. Discovery still skips an app it cannot convert and keeps looking, so a later command in the module is documented as before, and llms-full.txt is still written without the CLI.

This PR also narrows three other handlers on the build path. Colour in the build log is turned off only for a closed or missing standard output, the marimo islands version falls back to the pinned release only when marimo is not installed, and a directory's sidebar metadata reads as empty only when its file cannot be read or is not valid YAML. Errors outside these types now raise instead of being swallowed.

…tadata

Colour detection treats only a closed or missing standard output as "no colour". The marimo
islands version falls back to the pinned release only when marimo is not installed. A
directory's sidebar metadata reads as empty only when the file cannot be read or decoded, or
is not valid YAML. Any other error now surfaces instead of being hidden.
CLI discovery passes over a Typer app whose commands Typer cannot turn into a command line,
for example because a parameter has a type Typer does not support, and keeps looking, so a
later command in the module is still documented. When no command is found at all, discovery
used to report only that it found none. The CLI reference step now warns, naming each app
Typer rejected with Typer's error, and the build continues without CLI pages. An app with no
commands is still not treated as a command line, and llms-full.txt and API snapshots are still
written without the CLI.
@has2k1
has2k1 added this pull request to stack #632 November 6, 2026 12:43
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown

📚 Preview this PR's docs locally

Fetch the just-built site and open it in your browser:

# this exact build
great-docs preview --run 42219805502

# or always the latest build for this PR
great-docs preview --pr 630
Auth & tips
  • Requires great-docs: pip install great-docs (or run via pipx/uvx).
  • Auth: run gh auth login then add --use-gh, or set GITHUB_TOKEN (needs Actions: read).
  • Jump to a page: add --path reference/index.html.
  • Latest vs exact: --pr <n> grabs the newest build; --run <id> pins this one.
  • Re-download: --refresh ignores the local cache.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant