-
Notifications
You must be signed in to change notification settings - Fork 285
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
reorganise docs common links + add core devs #3972
Merged
tkknight
merged 2 commits into
SciTools:master
from
bjlittle:docs-add-core-devs-to-common-links
Feb 1, 2021
Merged
reorganise docs common links + add core devs #3972
tkknight
merged 2 commits into
SciTools:master
from
bjlittle:docs-add-core-devs-to-common-links
Feb 1, 2021
Conversation
This file contains 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
You can kinda create a comment in RestructuredText via using a directive that does not exist and without using the double colon. See https://docutils.sourceforge.io/docs/user/rst/quickref.html#substitution-references-and-definitions for more details. I would suggest using a coment directive, using any case (does not exist), like this:
|
Happy to approve and merge as is though @bjlittle |
tkknight
approved these changes
Feb 1, 2021
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 1, 2021
* upstream/master: document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 1, 2021
* master: remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 9, 2021
* master: (23 commits) Added text to state the Python version used to build the docs. (SciTools#3989) add nox session conda list (SciTools#3990) Add abstract cube summary (SciTools#3987) automate docs discovery of iris and python versions (SciTools#3981) corrected syntax (SciTools#3980) core dev whatsnew entry (SciTools#3978) moved docs dir and updated references to it (SciTools#3975) Fix test_incompatible_dimensions test (SciTools#3977) remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958) Put cube data on the x axis if plotting just a cube against a vertical or y coordinate (SciTools#3906) remove stock_mdi_arrays.npz (SciTools#3913) Gallery: update seasonal ensemble example (SciTools#3933) ...
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.
🚀 Pull Request
Description
This PR adds the
@github
name of theiris
core developers (in alphabetical order) to the documentation common links.It also organises the existing common resource links (in alphabetical order) as a separate category (and removing a duplicate in the process).
I attempted to use the
rst
only
directive (see #3971) as a comment heading for each category, but his caused the following warning:checking consistency... /net/home/h05/itwl/projects/git/iris/docs/iris/src/techpapers/change_management.rst: WARNING: document isn't included in any toctree
which causes the CI docs build to fail. Never mind.
After this PR is merged (and #3971), we can rationalise the
whatsnew
to remove core developer links.Consult Iris pull request check list