-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Update documentation to copy tags when forking, so versioning is reasonable #10576
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
Conversation
…ction of these docs
for more information, see https://pre-commit.ci
| If the *xarray* ``main`` branch version has updated since you last fetched changes, | ||
| you may also wish to reinstall xarray so that the pip version reflects the *xarray* | ||
| version:: | ||
| pip install -e . |
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.
I think you need an extra line break before code here, which is why the doc build is failing:
/home/docs/checkouts/readthedocs.org/user_builds/xray/checkouts/10576/doc/contribute/contributing.rst:282: ERROR: Unexpected indentation.
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.
Thanks; it was skipping over the error and building locally, but I think it's not throwing the error any more
…icit target name: "documentation""
|
Thank you, Jemma! |

The first of the commits is most critical to closing #10568, later commits are just to smooth out the reader's experience. The biggest change is moving "Create a develoment environment" up to when it's first mentioned, otherwise the flow of the docs seems to involve skipping to a later section and then skipping back.
Also tidied up a hyperlink that seemed to unintentionally link to pandas, and another one that used a https webpage instead of an internal cross-reference
@ianhi