Skip to content

Build API documentation #11

@thunderbiscuit

Description

@thunderbiscuit

Our Python library currently doesn't have a nice API documentation website. It'd be great to build one! This issue is up for grabs. Anyone interested in contributing to our Python library should consider it a great place to start.

Here are some of the thing that would be nice to have as part of this feature:

  1. Automatic builds in CI that export a zip file of the website, ready for upload on bitcoindevkit.org (where we host some of the other API docs websites).
  2. Clean UI in line with what is expected of Python libraries in the industry.

Previous work

You can see a previous PR that did some of that work here (bdk-ffi #752).

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