Skip to content

Commit 96d3e0f

Browse files
DOC: Add design idea of PyGMT logo to docstrings (#4719)
Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
1 parent c81f9b6 commit 96d3e0f

2 files changed

Lines changed: 20 additions & 1 deletion

File tree

pygmt/src/logo.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,11 @@ def logo( # noqa: PLR0913
9797
$perspective
9898
$transparency
9999
100+
See Also
101+
--------
102+
pygmt.Figure.pygmtlogo
103+
Plot the PyGMT logo.
104+
100105
Examples
101106
--------
102107
>>> import pygmt

pygmt/src/pygmtlogo.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,8 +291,17 @@ def pygmtlogo( # noqa: PLR0913
291291
"""
292292
Plot the PyGMT logo.
293293
294+
.. figure:: https://raw.githubusercontent.com/GenericMappingTools/pygmt/main/doc/_static/pygmtlogo.png
295+
:alt: PyGMT logo
296+
:align: center
297+
:width: 400px
298+
294299
The design of the logo is kindly provided by `@sfrooti <https://github.com/sfrooti>`_
295-
and consists of a visual and the wordmark "PyGMT".
300+
and consists of a visual and the wordmark "PyGMT". The outer shape (in Python blue)
301+
represents Earth, with compass lines (in Python yellow) surrounding the letters
302+
"GMT" (in the red used for the GMT logo). The letter "T" aligns with the needle of
303+
the compass. By default, the PyGMT logo is plotted without wordmark, with a size of
304+
2 centimeters for the circular version of the icon.
296305
297306
Parameters
298307
----------
@@ -338,6 +347,11 @@ def pygmtlogo( # noqa: PLR0913
338347
$perspective
339348
$transparency
340349
350+
See Also
351+
--------
352+
pygmt.Figure.logo
353+
Plot the GMT logo.
354+
341355
Examples
342356
--------
343357
>>> import pygmt

0 commit comments

Comments
 (0)