Skip to content

Add CI for documentation code snippets #164

@jenniferjiangkells

Description

@jenniferjiangkells

Description

Code examples in docs can become outdated as the codebase evolves, automated testing can help catch breaks and ensure docs stay in sync with code and ensure better onboarding experience for users.

  • Use pytest-codeblocks
  • Add skip markers for incomplete examples or placeholders

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Status

    Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions