-
Notifications
You must be signed in to change notification settings - Fork 216
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
doc: Convert the installation guides source code from ReST to Markdown #2992
Conversation
in the base environment. Installing Miniforge does not require administrative rights to | ||
your computer and doesn't interfere with any other Python installations on your system. | ||
|
||
## Which GMT? |
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.
The Markdown file is equivalent to the old ReST file, except that I changed:
PyGMT requires Generic Mapping Tools (GMT) >=6.3.0 since there are many changes being made to GMT itself in response to the development of PyGMT, mainly the new modern execution mode.
to
PyGMT requires Generic Mapping Tools (GMT) >=6.3.0 since there are many changes being made to GMT itself in response to the development of PyGMT.
mainly because PyGMT users don't have to know about GMT modern mode
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.
The new link is at https://docs.generic-mapping-tools.org/6.5/reference/introduction.html#modern-and-classic-mode, but yeah, should be ok to remove this part since GMT 6 has been around for 3+ years now.
] | ||
myst_substitutions = { |
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.
myst_substitutions = { | |
# These enable substitutions using {{ key }} in the Markdown files | |
myst_substitutions = { |
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.
myst_substitutions
's syntax is {{ key }}
and is only available in myst-markdown files. I've updated the suggestion.
# These enable substitutions using |variable| in the rst files | ||
rst_epilog = f""" | ||
.. |year| replace:: {year} | ||
.. |requires_python| replace:: {requires_python} | ||
.. |requires_gmt| replace:: {requires_gmt} | ||
""" |
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.
Ok to remove. Looks like we only use {year}
in the copyright line at L143 above.
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Address #2928.
Preview: https://pygmt-dev--2992.org.readthedocs.build/en/2992/install.html
Closes #2998.