Skip to content

fix(docs): add attrs/cattrs to script-requirements.txt#1430

Merged
hkad98 merged 1 commit intogooddata:masterfrom
hkad98:jkd/fix-docs-scripts
Mar 16, 2026
Merged

fix(docs): add attrs/cattrs to script-requirements.txt#1430
hkad98 merged 1 commit intogooddata:masterfrom
hkad98:jkd/fix-docs-scripts

Conversation

@hkad98
Copy link
Copy Markdown
Contributor

@hkad98 hkad98 commented Mar 16, 2026

Summary

  • Add attrs and cattrs as explicit dependencies in scripts/script-requirements.txt
  • These were previously provided transitively via editable installs (-e ./packages/gooddata-sdk etc.) which were removed in feat(docs): griffe + pre-renderer pipeline for method pages #1419
  • The Netlify deploy still needs them for json_builder.py on older release branches

…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 hkad98 merged commit 4289ee2 into gooddata:master Mar 16, 2026
6 checks passed
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.

2 participants