ZAM-370: Implement mdx_docs_generation.py in analyzers directory

[codegen-sh]

Description

This PR implements the missing mdx_docs_generation.py module in the codegen-on-oss/codegen_on_oss/analyzers/ directory. The module provides functionality for generating MDX documentation from code analysis.

Changes Made

1. Created the mdx_docs_generation.py module with the following functionality:

   • Rendering MDX pages for classes
   • Generating documentation for methods and attributes
   • Formatting parameters and return types
   • Sanitizing HTML and MDX content

2. Created the doc_utils package with the following modules:

   • schemas.py: Defines the data models for documentation
   • utils.py: Provides utility functions for documentation generation

3. Added comprehensive tests for the new functionality

Testing

Added unit tests to verify the functionality of the MDX documentation generation.

Fixes ZAM-370

---

💻 View my work • About Codegen

Summary by Sourcery

Implement MDX documentation generation in the analyzers module, add supporting schema and utility packages, and cover the new functionality with unit tests.

New Features:

• Add mdx_docs_generation.py to generate MDX pages for classes, methods, attributes, and inheritance
• Introduce doc_utils package with schemas and utilities for sanitizing and formatting documentation content

Tests:

• Add comprehensive unit tests for MDX rendering, formatting, routing, and sanitization logic

Description by Korbit AI

What change is being made?

Implement mdx_docs_generation.py in the analyzers directory to facilitate MDX documentation generation from code analysis, along with accompanying utilities, schemas, and tests.

Why are these changes being made?

These changes introduce functionalities for automated MDX documentation generation, enhancing the documentation process for code analysis by rendering class, method, and attribute details into MDX format. This facilitates consistency and aids developers in maintaining comprehensive and standardized documentation across projects. Additionally, it addresses any gaps in documenting the internal processes by providing schema definitions, utility functions for formatting documentation, and tests to ensure the reliability of the new functionality.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

[korbit-ai]

By default, I don't review pull requests opened by bots. If you would like me to review this pull request anyway, you can request a review via the /korbit-review command in a comment.

[coderabbitai]

Important

Review skipped

Bot user detected.

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.

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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? Join our Discord community 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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[sourcery-ai]

Reviewer's Guide

This PR adds a comprehensive MDX documentation generator for code analysis, introducing a new module that renders class, inheritance, attribute, and method sections with sanitized content and type resolution, supplemented by Pydantic-based schemas and utility functions, and backed by unit tests verifying all functionality.

File-Level Changes

Change	Details	Files
Implement MDX documentation generation module	Add render functions for class page, title, inheritance, attributes, and methods Implement parameter and return formatting with HTML/MDX sanitization Develop type resolution and link parsing utilities	codegen-on-oss/codegen_on_oss/analyzers/mdx_docs_generation.py
Introduce documentation utilities package	Define Pydantic schemas for ClassDoc, MethodDoc, and ParameterDoc Implement docstring sanitization and HTML escaping utilities Add package initialization file	codegen-on-oss/codegen_on_oss/analyzers/doc_utils/schemas.py codegen-on-oss/codegen_on_oss/analyzers/doc_utils/utils.py codegen-on-oss/codegen_on_oss/analyzers/doc_utils/__init__.py
Add unit tests for MDX documentation functionality	Test rendering of pages, sections, attributes, and methods Verify parameter and return formatting and type resolution Check MDX route generation based on class naming conventions	codegen-on-oss/codegen_on_oss/analyzers/tests/test_mdx_docs_generation.py codegen-on-oss/codegen_on_oss/analyzers/tests/__init__.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[codegen-sh]

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

[codegen-sh]

Hey! 👋 I see one of the checks failed. I am on it! 🫡

💻 View my work

[codegen-sh]

✅ Fixed the failing checks in PR #105. I identified and resolved the following issues:

1. Fixed linting issues in analyzer.py:
   • Removed redundant exception objects from logger.exception calls
   • Fixed parameter name shadowing a Python builtin (format → output_format)
   • Improved error message for ValueError

The changes have been pushed to the original PR branch. All mypy type checks are now passing as well.

These were relatively minor linting issues that didn't affect functionality but were caught by the pre-commit hooks.

💻 View my work • React 👍 or 👎