docs(python): API reference main - #20
Conversation
376c644 to
e6d5077
Compare
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the ResQ Python SDK API documentation by formatting the README and adding overview pages for the resq-dsa and resq-mcp packages. The review feedback suggests ordering the package list alphabetically in the README for consistency and highlights that the new overview files are currently empty, recommending that any content fixes be made at the source or generator level.
Two issues from resq-software/docs#20 review: 1. `pydoc-markdown -p <pkg>` does not recurse into submodules. Both overview.md files in the auto-PR contained only `# Table of Contents`. Discover submodules via pkgutil and pass every name explicitly via inline YAML loader config. Bumps renderer flags so the rendered layout matches what lazydocs produced before its 3.13 incompat. 2. README package list now sorts package directories alphabetically, matching _pages.json order. Sync from resq-software/docs#18 (commit a5b2afb).
Two issues from resq-software/docs#20 review: 1. `pydoc-markdown -p <pkg>` does not recurse into submodules. Both overview.md files in the auto-PR contained only `# Table of Contents`. Discover submodules via pkgutil and pass every name explicitly via inline YAML loader config. Bumps renderer flags so the rendered layout matches what lazydocs produced before its 3.13 incompat. 2. README package list now sorts package directories alphabetically, matching _pages.json order. Sync from resq-software/docs#18 (commit a5b2afb).
Single-line nav addition — points at sdks/python/api/README which Mintlify resolves via the existing .md file. No file renames; the auto-generated trees stay as .md because Mintlify's .md link resolver is filesystem-based and already accepts the cross-references TypeDoc / DefaultDocumentation / pydoc-markdown emit. Renaming the READMEs to .mdx (attempted in earlier commits 4e31133 / 7301dbc / 54934ef) was the wrong move — .mdx parents have stricter link resolution that requires every link target to be nav-registered, which is not feasible for 3500+ auto-generated pages. The "is referenced in docs.json navigation but the file does not exist" warning that mint dev emits for .md-extension README references is cosmetic; Mintlify still renders the page. The "Generated API Reference" group from PR #17 only had TypeScript and .NET sub-groups; PR #18 (Python template) and the resulting auto-PRs (#19, #20) landed the Python content after that PR was opened.
Single-line nav addition — points at sdks/python/api/README which Mintlify resolves via the existing .md file. No file renames; the auto-generated trees stay as .md because Mintlify's .md link resolver is filesystem-based and already accepts the cross-references TypeDoc / DefaultDocumentation / pydoc-markdown emit. Renaming the READMEs to .mdx (attempted in earlier commits 4e31133 / 7301dbc / 54934ef) was the wrong move — .mdx parents have stricter link resolution that requires every link target to be nav-registered, which is not feasible for 3500+ auto-generated pages. The "is referenced in docs.json navigation but the file does not exist" warning that mint dev emits for .md-extension README references is cosmetic; Mintlify still renders the page. The "Generated API Reference" group from PR #17 only had TypeScript and .NET sub-groups; PR #18 (Python template) and the resulting auto-PRs (#19, #20) landed the Python content after that PR was opened. Co-authored-by: Mike Odnis <engineer@resq.software>
2 participants
Auto-generated by
api-docsinresq-software/pypifor refmain(run: 25602333109).
Regenerated files under
sdks/python/api/. Review thediff for unintended exports and merge to publish.