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

Expand documentation linking in CONTRIBUTING.md #802

Merged
merged 28 commits into from
Mar 2, 2021
Merged
Changes from 17 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
27f5d20
Add cyl_transverse_mercator.py
willschlitzer Dec 11, 2020
d64983f
Add cyl_universal_transverse_mercator.py
willschlitzer Dec 11, 2020
6ba8185
Changing land color to red in cyl_mercator.py to match GMT docs examp…
willschlitzer Dec 11, 2020
76850ee
Merge branch 'master' into cylindrical-projections
willschlitzer Dec 13, 2020
48431db
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 12, 2021
01052d2
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 18, 2021
c710988
Merge remote-tracking branch 'origin/master'
willschlitzer Jan 21, 2021
b94e0a2
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 21, 2021
413fec1
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 22, 2021
be51e2c
Merge branch 'master' of https://github.com/GenericMappingTools/pygmt
willschlitzer Jan 22, 2021
cae850f
Add example for linking PyGMT methods and GMT docs
willschlitzer Jan 23, 2021
99c654f
Merge branch 'master' into contributing-links
willschlitzer Feb 4, 2021
0878c5f
Add GMT docs linking example
willschlitzer Feb 4, 2021
4f61c0c
Update paragraphs in CONTRIBUTING.md
willschlitzer Feb 4, 2021
91e4a3d
Merge branch 'master' into contributing-links
willschlitzer Feb 19, 2021
d378aed
Add example to link to PyGMT method
willschlitzer Feb 19, 2021
aa15aae
Add example to link to PyGMT documentation
willschlitzer Feb 19, 2021
2bfe227
Apply suggestions from code review
willschlitzer Feb 19, 2021
540ba53
Grammar correction
willschlitzer Feb 19, 2021
34ef069
Apply suggestions from code review
willschlitzer Feb 20, 2021
497e0d7
Apply suggestions from code review
willschlitzer Feb 21, 2021
8d4cef8
Update CONTRIBUTING.md
willschlitzer Feb 22, 2021
3be8285
Apply suggestions from code review
willschlitzer Feb 22, 2021
610b982
Merge branch 'master' into contributing-links
willschlitzer Feb 22, 2021
df69a1e
Merge branch 'master' into contributing-links
willschlitzer Feb 26, 2021
cb7b930
Update CONTRIBUTING.md
willschlitzer Mar 1, 2021
b3bab2c
Merge branch 'master' into contributing-links
willschlitzer Mar 1, 2021
19a2241
Merge branch 'master' into contributing-links
seisman Mar 2, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -441,10 +441,21 @@ The API reference is manually assembled in `doc/api/index.rst`.
The *autodoc* sphinx extension will automatically create pages for each
function/class/module listed there.

You can reference classes, functions, and modules from anywhere (including docstrings)
using <code>:func:\`package.module.function\`</code>,
<code>:class:\`package.module.class\`</code>, or
<code>:mod:\`package.module\`</code>.
You can reference classes, functions, methods, and modules from anywhere
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
(including docstrings) using <code>:func:\`package.module.function\`</code>,
<code>:class:\`package.module.class\`</code>,
<code>:meth:\`package.module.method\`</code>, or
<code>:mod:\`package.module\`</code>. An example would be to use
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
<code>\`:meth:\`pygmt.Figure.grdview\`\`</code> to link
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
to :meth:`pygmt.Figure.grdview`. PyGMT documentation that is not a class, method,
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
or module can be linked with :doc:`Any Link Text </path/to/the/file>`
And example would be <code>:doc:`Install instructions </install>`</code> links
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved
to https://www.pygmt.org/dev/install.html.

GMT documentation can be linked with
<code>:gmt-docs:\`page_name.html\`</code>. An example would be using
<code>\`:gmt-docs:\`makecpt.html\`\`</code> to link to :gmt-docs:`makecpt.html`.
seisman marked this conversation as resolved.
Show resolved Hide resolved
willschlitzer marked this conversation as resolved.
Show resolved Hide resolved

Sphinx will create a link to the automatically generated page for that
function/class/module.

Expand Down