🔥 Added API Docs#520
Conversation
|
✅ 9/9 passed, 53m29s total Running from acceptance #1811 |
mwojtyczka
left a comment
There was a problem hiding this comment.
Generally LGTM - small comments.
Pls also add info in the contributing guide that clasess/methods/funcs should have a proper docstring, otherwise they are ommited from the api docs.
Co-authored-by: Marcin Wojtyczka <marcin.wojtyczka@databricks.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR introduces automatic API documentation generation using pydoc-markdown to create comprehensive API documentation from Python docstrings. The changes include:
- Converting inline docstring format from rST to Google-style (Args/Returns/Raises sections)
- Setting up pydoc-markdown configuration for automated API doc generation
- Minor code formatting improvements (removing empty lines)
Reviewed Changes
Copilot reviewed 44 out of 46 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pyproject.toml | Added pydoc-markdown configuration and docs environment |
| docs/dqx/ | Updated docusaurus configuration for API docs |
| src/databricks/labs/dqx/ | Converted docstrings from rST to Google-style format |
| tests/ | Minor formatting fixes and docstring updates |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
Changes: