Skip to content

Generate python documentation #40

Description

@bovee

It looks like it's possible to run pydoc against the package generated by pyo3 so we should consider trying to generate API documentation above and beyond that inside the docstrings, if possible.

Screen Shot 2019-12-03 at 11 18 29 AM

Something like sphinx or mkdocs would probably be better and we may want to publish to readthedocs also?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions