initial python docs for bdk #635
Conversation
|
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
| output_file = 'docs/api.rst' | ||
|
|
||
| # Define categories and corresponding classes | ||
| categories = { |
There was a problem hiding this comment.
categories are specified here. see index for all methods.
|
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. |
| python -m pip install --upgrade pip | ||
| pip install -r requirements.txt | ||
| pip install sphinx sphinx-rtd-theme | ||
|
|
There was a problem hiding this comment.
I noticed I have to install the pdkpython package, to get sphinx to be able to import the bdkpython module.
The steps from
could be copied in here.
|
Great PR. The docs looks very nice, and a rebase to master is without issues. Just the workflow needs to be tested (see #635 (comment) ) |
|
This PR is being continued in #752. @bitkarrot if you use your master branch for PRs, maintainers can't add fixes or rebase and force push. Feel free to continue the discussion in #752! And thanks for this, I know we've been slow at getting to it but it's awesome to see it work. |
|
Thanks for all the hard work! |
Description
add Python docs
Checklists
All Submissions:
New Features: