Skip to content
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

preliminary pr to examine the DataTree injected docs. #8977

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

flamingbear
Copy link
Contributor

This PR should never be merged, it is opened only to run the build-the-docs with the changes from #8976

I just wanted to make sure I could point to what the final doc pages will look like when datatree is released.

I considered wedging this into core/ops.py, but the datatree/ops.py stuff is
kind of spread into core/ops.py and generated_aggregations.py.
These are the only docstring that have a leading space and that was causing
problems injecting the map_over_subtree information in the Datatree doc strings.
This works on most of the docstrings.

The DatasetOpsMixin functions (round, argsorg, conj and conjugate) have
different format and this gets inserted after the name (which is non standard
in most docs) but before the description.
Just syntactic sugar to make that work
@flamingbear
Copy link
Contributor Author

There's not a lot of diffs between this and my #8976 pr. You can see that here.

Looks like I'm now clogging read the docs and can't kill either of the builds for this PR.
this is stuck? https://readthedocs.org/projects/xray/builds/24200886/

Anyone want to kill it for me?

Screenshot 2024-04-26 at 4 01 47 PM

@dcherian
Copy link
Contributor

@flamingbear What's your RTD username?

@flamingbear
Copy link
Contributor Author

flamingbear commented Apr 26, 2024

@flamingbear What's your RTD username?

looks like msavoie

@dcherian
Copy link
Contributor

OK you now have an admin invite. Plz don't click delete :)

@flamingbear
Copy link
Contributor Author

flamingbear commented Apr 26, 2024

I killed one so builds should be able to continue, but https://readthedocs.org/projects/xray/builds/24200886/ is being stubborn I tried to cancel it on the old and new dashboards 🤷. it timed out

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

Successfully merging this pull request may close these issues.

None yet

2 participants