Skip to content

docs: regenerate API refs with mdxify >=0.2.45 (drop empty stubs)#22344

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

docs: regenerate API refs with mdxify >=0.2.45 (drop empty stubs)#22344
zzstoatzz merged 1 commit into
mainfrom
docs/mdxify-integrations-empty-stubs

Conversation

@zzstoatzz

@zzstoatzz zzstoatzz commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

Companion to #22339 (core SDK, merged). Bumps mdxify to >=0.2.45 across the core justfile/scripts/generate_api_ref.py and all 18 integration justfiles, and does a full regeneration. Removes 35 empty-module stub pages across 8 integrations + their nav entries.

mdxify 0.2.45 does no docstring escaping — the earlier brace-escaping attempts were reverted (zzstoatzz/mdxify#47) as the wrong layer. Where a regenerated docstring didn't render as valid MDX, the fix is in the source docstring, not an escaping pass:

  • prefect-databricks flows.py: wrapped bare JSON dict examples in backticks (inline code).
  • prefect-databricks jobs.py: collapsed multi-line inline-code spans onto a single line (MDX only treats single-line backtick spans as code).

Verified: npx mint broken-links → "success no broken links found", 0 orphans.

Notable
  • prefect-gcp: dropped --no-update-nav from its justfile so its nav regenerates like every other integration (its hand-maintained nav had drifted to a removed experimental.* module path).
  • Empty stubs removed: aws (8), azure (7), dbt (4), docker (3), kubernetes (2), databricks (1), github (1), gcp.

🤖 Generated with Claude Code

@github-actions github-actions Bot added the docs label Jun 22, 2026
@zzstoatzz
zzstoatzz force-pushed the docs/mdxify-integrations-empty-stubs branch from 795dc11 to 7b21db1 Compare June 22, 2026 18:37
@zzstoatzz zzstoatzz changed the title docs: sweep integration API refs with mdxify >=0.2.42, drop empty stubs docs: sweep integration API refs with mdxify >=0.2.43 Jun 22, 2026
@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 🟢 Ready View Preview Jun 22, 2026, 6:49 PM

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

@zzstoatzz
zzstoatzz force-pushed the docs/mdxify-integrations-empty-stubs branch from 7b21db1 to 7a8af13 Compare June 22, 2026 19:05
@zzstoatzz zzstoatzz changed the title docs: sweep integration API refs with mdxify >=0.2.43 docs: regenerate integration API refs with mdxify >=0.2.44 (drop empty stubs) Jun 22, 2026
@zzstoatzz
zzstoatzz marked this pull request as ready for review June 22, 2026 19:30
@zzstoatzz
zzstoatzz force-pushed the docs/mdxify-integrations-empty-stubs branch 2 times, most recently from 26d34ac to b3690df Compare June 22, 2026 19:48
@zzstoatzz zzstoatzz changed the title docs: regenerate integration API refs with mdxify >=0.2.44 (drop empty stubs) docs: regenerate API refs with mdxify >=0.2.45 (drop empty stubs) Jun 22, 2026
Rebased onto #22348 (databricks docstring cleanup). Bumps mdxify to >=0.2.45
across the core justfile/scripts and all 18 integration justfiles, and fully
regenerates the API references. Removes empty-module stub pages and their nav
entries.

Regenerating also brings the prefect-databricks api-ref docs in line with the
rewritten source docstrings from #22348 (which updated the source but did not
regenerate the docs), and applies its prefect_databricks.models exclusion.

prefect-gcp: dropped --no-update-nav so its nav regenerates like every other
integration (its hand-maintained nav had drifted).

Verified: `mint broken-links` clean, 0 dead links / 0 orphans.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@zzstoatzz
zzstoatzz merged commit 0c97ac4 into main Jun 22, 2026
86 of 91 checks passed
@zzstoatzz
zzstoatzz deleted the docs/mdxify-integrations-empty-stubs branch June 22, 2026 20:58
br413 pushed a commit to br413/prefect that referenced this pull request Jul 14, 2026
…efectHQ#22344)

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