Skip to content

Build Sphinx documentation and host on ReadTheDocs #211

Description

@JWCook

It would be helpful to have HTML documentation for gpxpy. It appears that the source code is the main source of documentation currently.

Since gpxpy already has type annotations and some docstrings, it would be fairly simple to use sphinx-apidoc and sphinx-autodoc-typehints to generate HTML docs using the information that's already present.

I would be willing to set this up, if you'd be open to a PR for this.

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