Merge branch 'main' into changelog/v0.15.0

Author: seisman

.github/workflows/ci_docs.yml

@@ -176,7 +176,7 @@ jobs:
           path: deploy
           # Download the entire history
           fetch-depth: 0
-          persist-credentials: false
+          persist-credentials: true
         if: (github.event_name == 'release' || github.event_name == 'push') && (matrix.os == 'ubuntu-latest')
 
       - name: Push the built HTML to gh-pages

.github/workflows/release-drafter.yml

@@ -1,8 +1,7 @@
 # Draft the next release notes
 #
-# This workflow is run to update the next release notes as pull requests are
-# merged into the main branch. The configuration file is located at
-# `.github/release-drafter.yml`.
+# This workflow is run to update the next release notes as pull requests are merged into
+# the main branch. The configuration file is located at `.github/release-drafter.yml`.
 #
 name: Release Drafter
 
@@ -11,10 +10,14 @@ on:
     branches:
       - main
 
-permissions: {}
+permissions:
+  contents: read
 
 jobs:
   update_release_draft:
+    permissions:
+      # write permission is required to create a github release
+      contents: write
     runs-on: ubuntu-latest
     if: github.repository == 'GenericMappingTools/pygmt'
 

doc/techref/common_parameters.md

@@ -0,0 +1,16 @@
+# Common Parameters
+
+```{glossary}
+``verbose``
+    Select verbosity level, which modulates the messages written to stderr.
+
+    Choose among 7 levels of verbosity [Default is ``"w"``]:
+
+    - ``"q"``: Quiet, not even fatal error messages are produced
+    - ``"e"``: Error messages only
+    - ``"w"``: Warnings [Default]
+    - ``"t"``: Timings (report runtimes for time-intensive algorithms)
+    - ``"i"``: Informational messages (same as ``verbose=True``)
+    - ``"c"``: Compatibility warnings
+    - ``"d"``: Debugging messages
+```

doc/techref/index.md

@@ -8,6 +8,7 @@ visit the {gmt-docs}`GMT Technical Reference <reference.html>`.
 ```{toctree}
 :maxdepth: 1
 
+common_parameters.md
 projections.md
 fonts.md
 patterns.md

pygmt/helpers/decorators.py

@@ -364,16 +364,7 @@
             in the image (for further processing). """,
     "verbose": r"""
         verbose : bool or str
-            Select verbosity level [Default is **w**], which modulates the messages
-            written to stderr. Choose among 7 levels of verbosity:
-
-            - **q**: Quiet, not even fatal error messages are produced
-            - **e**: Error messages only
-            - **w**: Warnings [Default]
-            - **t**: Timings (report runtimes for time-intensive algorithms)
-            - **i**: Informational messages (same as ``verbose=True``)
-            - **c**: Compatibility warnings
-            - **d**: Debugging messages""",
+            Select verbosity level [:term:`Full usage <verbose>`].""",
     "wrap": r"""
         wrap : str
             **y**\|\ **a**\|\ **w**\|\ **d**\|\ **h**\|\ **m**\|\ **s**\|\