Skip to content

Add automatic API documentation generation from package docstrings #5

@Joao-Paulo-Silva

Description

@Joao-Paulo-Silva

Currently, package API documentation is not automatically generated. It's necessary to evaluate and implement a solution that generates Docusaurus-compatible documentation from docstrings, ensuring it is always up-to-date throughout the deployment cycle.

Possible approaches:

  • Evaluate tools such as pdocs, MkDocs, or similar for automatic documentation generation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions