Skip to content

Adding Python API to Docs #928

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

Closed
wants to merge 1 commit into from

Conversation

sekyondaMeta
Copy link
Contributor

@sekyondaMeta sekyondaMeta commented Aug 19, 2025

Python API Build plus a doc explaining the whole doc build.
For a preview of the docs see: https://github.com/meta-pytorch/monarch/actions/runs/17143392713/artifacts/3824515008

Next steps:

  • See if we can make the API build less complicated
  • Need more docstring coverage

Quick preview:
Screenshot 2025-08-21 at 18 20 15
Screenshot 2025-08-21 at 18 20 23

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Aug 19, 2025
@sekyondaMeta sekyondaMeta changed the title [DO NOT MERGE] Python API Test 2 Adding Python API Aug 22, 2025
@sekyondaMeta sekyondaMeta changed the title Adding Python API Adding Python API to Docs Aug 22, 2025
@sekyondaMeta sekyondaMeta marked this pull request as ready for review August 22, 2025 02:49
Python API
==========

.. note::
Copy link
Member

Choose a reason for hiding this comment

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

is this autogenerated?

Copy link
Contributor

@johnwhumphreys johnwhumphreys left a comment

Choose a reason for hiding this comment

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

This looks awesome; very clean. Just one question (echoing @dcci) - are index.rst and all those things auto-generated? They look generated, but are checked in - would assume if generated, we could avoid checking them in. Otherwise, looks very good; love all the verification checks/metadocs/etc.

@facebook-github-bot
Copy link
Contributor

@sekyondaMeta has imported this pull request. If you are a Meta employee, you can view this in D80815453.

Summary:
Python API Build plus a doc explaining the whole doc build.
For a preview of the docs see: https://github.com/meta-pytorch/monarch/actions/runs/17143392713/artifacts/3824515008

Next steps:
- See if we can make the API build less complicated
- Need more docstring coverage

Quick preview:
<img width="1580" height="907" alt="Screenshot 2025-08-21 at 18 20 15" src="https://github.com/user-attachments/assets/cf44077d-a6df-44ca-b3ff-072d022ae8f9" />
<img width="1574" height="911" alt="Screenshot 2025-08-21 at 18 20 23" src="https://github.com/user-attachments/assets/6db7497b-85ac-46cb-b6a8-1a1e419c9f24" />


Test Plan:
Imported from GitHub, without a `Test Plan:` line.

Rollback Plan:

Reviewed By: colin2328

Differential Revision: D80815453

Pulled By: sekyondaMeta
@facebook-github-bot
Copy link
Contributor

This pull request was exported from Phabricator. Differential Revision: D80815453

@facebook-github-bot
Copy link
Contributor

@sekyondaMeta merged this pull request in d55dec2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Meta Open Source bot. fb-exported Merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants