Feature/sdk docs from field description

[AlexejPenner]

Describe changes

1. Trigger Point

When docs/mkdocstrings_helper.py runs (during doc generation), it now calls process_pydantic_files_in_directory() first.

2. File Processing

def process_pydantic_files_in_directory(directory: Path) -> None:
# Finds all .py files recursively in src/zenml/
# For each file, calls generate_docstring_attributes_from_fields()

3. AST Parsing & Field Extraction

def generate_docstring_attributes_from_fields(file_path: Path) -> None:
# Uses Python AST (Abstract Syntax Tree) to parse the source code
# Looks for classes that have Field() definitions
# Extracts the description parameter from each Field()

4. Example Transformation

Before (Current state):
class KubernetesOrchestratorSettings(BaseSettings):
"""Settings for the Kubernetes orchestrator."""

  synchronous: bool = Field(
      default=True,
      description="Whether to wait for all pipeline steps to complete."
  )
  timeout: int = Field(
      default=0,
      description="Maximum seconds to wait for synchronous runs."
  )

After (Auto-generated during doc build):
class KubernetesOrchestratorSettings(BaseSettings):
"""Settings for the Kubernetes orchestrator.

  Attributes:
      synchronous: Whether to wait for all pipeline steps to complete.
      timeout: Maximum seconds to wait for synchronous runs.
  """

  synchronous: bool = Field(
      default=True,
      description="Whether to wait for all pipeline steps to complete."
  )
  timeout: int = Field(
      default=0,
      description="Maximum seconds to wait for synchronous runs."
  )

5. Key Benefits

6. Single Source of Truth: Field descriptions remain the authoritative documentation

7. Build-Time Only: Changes only happen during doc generation, not in the PyPI package

8. No Maintenance: No manual duplication needed

9. mkdocstrings Compatible: Generated docstrings work perfectly with existing tooling

10. Workflow

graph TD
A[Developer adds Field descriptions] --> B[Code committed without docstring attributes]
B --> C[CI runs docs/generate-docs.sh]
C --> D[mkdocstrings_helper.py processes files]
D --> E[Auto-generates docstring attributes from Field descriptions]
E --> F[mkdocs builds SDK docs with visible attributes]
F --> G[SDK docs show both class docs AND field descriptions]

7. Safety Features

• Non-destructive: Only adds attributes if they don't already exist
• Error handling: Gracefully handles parsing errors
• Selective: Only processes files that import pydantic
• Preserves existing: Won't overwrite manually written attributes

Pre-requisites

Please ensure you have done the following:

• I have read the CONTRIBUTING.md document.
• I have added tests to cover my changes.
• I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
• IMPORTANT: I made sure that my changes are reflected properly in the following resources:
  • ZenML Docs
  • Dashboard: Needs to be communicated to the frontend team.
  • Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
  • Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Other (add details above)

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.