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.
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.
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.
| "colon_fence", # Allow code fences using colons | ||
| "substitution", # Allow substituitions | ||
| ] | ||
| myst_substitutions = { |
There was a problem hiding this comment.
| myst_substitutions = { | |
| # These enable substitutions using {{ key }} in the Markdown files | |
| myst_substitutions = { |
There was a problem hiding this comment.
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.
Ok to remove. Looks like we only use {year} in the copyright line at L143 above.
weiji14
added
final review call
Co-authored-by: Wei Ji <[email protected]>
seisman
removed
the
final review call
Address #2928.
Preview: https://pygmt-dev--2992.org.readthedocs.build/en/2992/install.html
Closes #2998.