feat(docs): griffe + pre-renderer pipeline for method pages#1419
Merged
hkad98 merged 2 commits intogooddata:masterfrom Mar 16, 2026
Merged
feat(docs): griffe + pre-renderer pipeline for method pages#1419hkad98 merged 2 commits intogooddata:masterfrom
hkad98 merged 2 commits intogooddata:masterfrom
Conversation
The docs json_builder.py script expects Google-style docstrings but several functions used RST-style (:param/:return:), had missing summary lines before Args sections, or had improperly indented continuation lines — all causing "Invalid docstring" warnings during docs generation. jira: TRIVIAL risk: low
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1419 +/- ##
=======================================
Coverage 77.36% 77.36%
=======================================
Files 228 228
Lines 14775 14775
=======================================
Hits 11430 11430
Misses 3345 3345 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…rer pipeline Replace 136 manually maintained method documentation pages with a directive-based system where signature, parameters, and returns are auto-generated from code docstrings via griffe static AST analysis. Key changes: - Add griffe_builder.py: static AST replacement for json_builder.py — produces identical data.json without requiring package installation (~1.1s vs ~1.8s) - Add method_page_renderer.py: pre-renders method pages from api_ref frontmatter, with type names hyperlinked to API reference pages via links.json - Add migrate_method_pages.py: one-time migration that converted 136 pages to api_ref directive format, preserving hand-written Example sections - Update python_ref_builder.py: fix dedup bug that skipped recursion into duplicate-named modules (e.g. CatalogWorkspace was unreachable), add --export-links flag to export type->URL mapping for method_page_renderer - Update generate.sh and generate-single-version.sh: prefer griffe over legacy json_builder, call method_page_renderer with --links-json - Fix 9 docstrings with invalid "Args: None" pattern and 3 with missing blank lines before Args/Returns sections - Delete 12 unused Hugo shortcode/partial templates (api-ref-*, parameter*) - Add 91 unit tests (up from 33) covering griffe builder, method renderer, link resolution, frontmatter parsing, idempotency, and edge cases - Update scripts/docs/README.md with new pipeline documentation jira: trivial risk: nonprod
hkad98
force-pushed
the
jkd/fix-docs-scripts
branch
from
ecf8d2b to
4926843
Compare
Mara3l
approved these changes
Mar 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
griffe_builder.pyfor static AST-based API introspection (replaces runtimejson_builder.py)method_page_renderer.pyto pre-render method documentation pages from docstrings at build timeapi_reffrontmatter to all 146 method pages so the renderer can resolve themapi-ref,parameter,parameters-block) that are no longer neededgenerate-single-version.shto use the new pipeline