Commit ecf8d2b
committed
feat(docs): replace hand-written method pages with griffe + pre-renderer 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: nonprod1 parent 9a00fc2 commit ecf8d2b
File tree
175 files changed
+2018
-581
lines changed- docs
- content/en/latest
- administration
- appearance
- notification-channels
- organization
- permissions
- user-groups
- users-and-user-groups
- users
- data
- data-source
- physical-data-model
- execution
- ai
- exports
- workspace-content
- analytics-model
- localization
- logical-data-model
- workspace-content
- workspace
- workspace-data-filters
- workspaces
- layouts
- partials
- shortcodes
- public
- versioned_docs
- packages/gooddata-sdk/src/gooddata_sdk/catalog
- data_source
- export
- permission
- user
- workspace
- scripts
- docs
- tests
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
175 files changed
+2018
-581
lines changedLines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
Lines changed: 1 addition & 0 deletions
0 commit comments