Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

initial python docs for bdk #635

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

bitkarrot
Copy link

@bitkarrot bitkarrot commented Dec 10, 2024

Description

add Python docs

Checklists

All Submissions:

New Features:

  • I've added docs for the new feature

@notmandatory notmandatory added the documentation Improvements or additions to documentation label Dec 10, 2024
@bitkarrot
Copy link
Author

I need to go back and fix some syntax so this PR is not quite ready

 add script and instructions to readme

 fixup formatting

 fixup yaml workflow file

 modify generate docs script and format a bit better

add manually format api.rst for sections

 latest docs generated
@bitkarrot bitkarrot changed the title initial python docs attempt initial python docs for bdk Dec 10, 2024
output_file = 'docs/api.rst'

# Define categories and corresponding classes
categories = {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

categories are specified here. see index for all methods.

@bitkarrot
Copy link
Author

ok docs cleaned up with some instructions added. There are some warnings that still show; categories manually added in (#635 (comment)) to make menu nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants