Skip to content

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

thunderbiscuit
Copy link
Member

@thunderbiscuit thunderbiscuit commented Apr 30, 2025

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:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

@thunderbiscuit thunderbiscuit mentioned this pull request Apr 30, 2025
3 tasks
@thunderbiscuit thunderbiscuit force-pushed the docs/python-api-docs branch 2 times, most recently from 97b1289 to a98bbd0 Compare April 30, 2025 15:40
@thunderbiscuit
Copy link
Member Author

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 generate_docs.py file, and even then I don't know if this is the proper way to do this.

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.

@thunderbiscuit thunderbiscuit force-pushed the docs/python-api-docs branch from a98bbd0 to 7f4498c Compare May 1, 2025 14:52
@thunderbiscuit thunderbiscuit force-pushed the docs/python-api-docs branch from 7f4498c to 3942d70 Compare May 1, 2025 14:52
@rustaceanrob
Copy link
Collaborator

Passes the sanity check, although I don't have much to add in terms of Python.

ACK 3942d70

@reez
Copy link
Collaborator

reez commented Jun 12, 2025

This looks almost good to me, but I think it needs one change. I think we need to not ignore index.rst and then add that file back. I think it was ignored/removed in 52514d2 along with all the other items rightfully ignored.

Sphinx documentation doesn't specifically say this verbatim, but it does consistently show index.rst as a manually created and maintained file, while showing auto-generation only for API reference files.

And it also lines up with the error I got building locally Sphinx is unable to load the master document, and was resolved when I added index.rst back and removed it from the .gitignore

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

Screenshot 2025-06-12 at 5 00 05 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants