-
Notifications
You must be signed in to change notification settings - Fork 55
Add Python API Docs #752
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
base: master
Are you sure you want to change the base?
Add Python API Docs #752
Conversation
97b1289
to
a98bbd0
Compare
I'm not comfortable enough with my Python to really know whether this is correctly done. I had to ChatGPT my way through reworking the I don't have a strong opinion on this yet, but it's at least in a workable form and there is probably little harm in adding a few files that build API docs. I'd like comments from other maintainers on this if possible, and from users. Tagging the crew here: @reez @ItoroD @bitkarrot @rustaceanrob @andreasgriffin. |
a98bbd0
to
7f4498c
Compare
7f4498c
to
3942d70
Compare
Passes the sanity check, although I don't have much to add in terms of Python. ACK 3942d70 |
This looks almost good to me, but I think it needs one change. I think we need to not ignore Sphinx documentation doesn't specifically say this verbatim, but it does consistently show And it also lines up with the error I got building locally Not a python expert, so let me know if I'm off or just what you think, I could be missing something. Also, one open comment/question: it doesn't look like this auto-deploys docs or anything that I can see, so I was just thinking about the deployment process for these docs, didn't know if someone already had a plan, assuming we would probably want to set something up similar to Jvm/android too but just didn't see anything related to that in this PR ![]() |
This is a continuation of #635.
@bitkarrot I was not able to rebase and force push to your PR because it uses your master branch which is protected.
Checklists
All Submissions:
cargo fmt
andcargo clippy
before committing