Skip to content

docs: bump mdxify to >=0.2.42, drop empty API-ref stubs#22339

Merged
zzstoatzz merged 1 commit into
mainfrom
docs/mdxify-0.2.40-empty-modules
Jun 22, 2026
Merged

docs: bump mdxify to >=0.2.42, drop empty API-ref stubs#22339
zzstoatzz merged 1 commit into
mainfrom
docs/mdxify-0.2.40-empty-modules

Conversation

@zzstoatzz

@zzstoatzz zzstoatzz commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Bumps the mdxify floor to >=0.2.42 and regenerates the Python SDK API reference. mdxify 0.2.42 stops generating placeholder pages for empty modules and fixes related navigation dead links. The regen removes 46 dead stub pages (e.g. the prefect-cli-__init__ page that just read "This module is empty…") and cleans up their navigation entries.

Verified: 0 dead links and 0 orphans across all 360 API-ref nav entries.

What changed
  • Pin floor → >=0.2.42 in justfile (api-ref-all, api-ref) and scripts/generate_api_ref.py. Previously these used bare mdxify / mdxify@latest with no lower bound.
  • Regen output (just api-ref-all):
    • 46 empty .mdx stubs deleted
    • docs/docs.json nav trimmed and repointed: packages whose only submodules are private (prefect.cli.deploy, prefect.cli.transfer) now link to their actual -__init__ pages instead of a 404
mdxify fixes this depends on

🤖 Generated with Claude Code

@github-actions github-actions Bot added the docs label Jun 22, 2026
mdxify 0.2.42 no longer generates placeholder pages for empty modules and
fixes navigation dead links. Regenerating drops 46 empty SDK reference
stubs (e.g. prefect-cli-__init__) and their nav entries, and repoints
packages with only-private submodules (prefect.cli.deploy, .transfer) at
their actual -__init__ pages.

Verified: 0 dead links and 0 orphans across all 360 API-ref nav entries.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@zzstoatzz
zzstoatzz force-pushed the docs/mdxify-0.2.40-empty-modules branch from a1f4c2f to 120b719 Compare June 22, 2026 16:56
@zzstoatzz zzstoatzz changed the title docs: bump mdxify to >=0.2.40, drop empty API-ref stubs docs: bump mdxify to >=0.2.42, drop empty API-ref stubs Jun 22, 2026
@zzstoatzz
zzstoatzz marked this pull request as ready for review June 22, 2026 17:27
@zzstoatzz
zzstoatzz merged commit a4e1b8e into main Jun 22, 2026
16 checks passed
@zzstoatzz
zzstoatzz deleted the docs/mdxify-0.2.40-empty-modules branch June 22, 2026 17:29
@mintlify

mintlify Bot commented Jun 22, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
prefect-oss 🔴 Failed Jun 22, 2026, 5:37 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

br413 pushed a commit to br413/prefect that referenced this pull request Jul 14, 2026
)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants