SphinxDocs set up #572
Draft
SphinxDocs set up #572
+943
−507
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Doc build 1
Update to add examples, update the index landing page and add a getting started
meta-cla
bot
added
the
CLA Signed
svekars
reviewed
Jul 22, 2025
| @@ -0,0 +1,52 @@ | |||
| name: Docs | |||
There was a problem hiding this comment.
Can you add .DS_Store to .gitignore, and any sphinx related build files, like _build/ build/?
svekars
reviewed
Jul 22, 2025
docs/source/GenerateExamples.py
Outdated
| @@ -0,0 +1,98 @@ | |||
| import os | |||
There was a problem hiding this comment.
Can you explain why this script is needed?
I think you can do a much simpler setup for sphinx gallery and specify those in the conf.py. https://sphinx-gallery.github.io/stable/configuration.html
|
|
||
| Here are some suggested steps to get started with Monarch: | ||
|
|
||
| 1. **Installation**: Install Monarch using pip: `pip install torchmonarch-nightly` |
There was a problem hiding this comment.
Getting started has more detail on installation, so may just start with that and skip #1.
svekars
reviewed
Jul 23, 2025
| run: | | ||
| set -eux | ||
|
|
||
| pip install -r docs/requirements.txt |
There was a problem hiding this comment.
Need to install requirements.txt from the root of the repo.
and then build monarch from source: pip install --no-build-isolation .
svekars
reviewed
Jul 23, 2025
| sphinxcontrib-mermaid==1.0.0 | ||
| myst-parser #==0.18.1 # if want to contribute in markdown | ||
| sphinx-gallery==0.14.0 # only if hosting interactive tutorials | ||
| sphinx-sitemap==2.7.1 |
There was a problem hiding this comment.
Add sphinx-rust== figure out the version
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Creating a sphinx site for the monarch docs
Example mock ups:
