Skip to content

Generate and publish API documentation #41

Description

@hickford

Great library! It was comprehensive docstrings, so it would be helpful to generate API documentation with Sphinx and publish on the Read the Docs. Published documentation is easier to browse, search and link.

https://www.sphinx-doc.org/en/master/
https://readthedocs.org/

Many many other Python projects use Sphinx and Read the Docs, eg. https://docs.python-requests.org/en/master/

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

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions