-
-
Notifications
You must be signed in to change notification settings - Fork 15
Add basic documentation site #227
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: main
Are you sure you want to change the base?
Conversation
|
Would it be possible to add an updated version of the release tracker table to the docs? This would be a great place to list all supported ufuncs and where we could later document e.g. the ULPs for each function |
|
Thanks @melissawm @juntyr yeah we will extend this, to add all those details |
| ] | ||
|
|
||
| docs = [ | ||
| "sphinx", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ngoldbaum (didn't explored in deep yet) Would this startup setup be extendable to your work (https://unyt.readthedocs.io/en/stable/)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, unyt also uses sphinx. It doesn't use myst because unyt predates myst.
I would defer to Melissa's setup. Maybe look at unyt if you're interested in setting up doctesting.
|
@SwayamInSync Should we just merge this in for 1.0? |
|
I was having some plans for this actually, |
|
You can but I wouldn't recommend it. It's much better IMO for doc changes to happen at the same time as code changes. My recommendation is to merge this, set up a docs site on github pages or readthedocs, and iterate from there. |
Sure then, I'll resolve its conflict and merge in after #246 |
@SwayamInSync so sorry it took me so long!!
Here's a basic docs site setup. I haven't set up the website yet, but I can give you instructions later. Here's a preview of how the site looks like right now: https://melissawm.github.io/numpy-user-dtypes/