Add documentation for common options/parameter in the "Technical Reference" section

[seisman]

GMT modules have common options (e.g., -J/-R/-V), which are aliased to standardized parameters in PyGMT (e.g., projection, region, verbose). Currently, the docstrings for some parameters are lengthy and take up a significant portion of the documentation pages, making it harder to focus on module-specific options.

To improve readability, I propose moving the detailed explanations of these common parameters to a dedicated page in the "Technical Reference" section. In the wrapper documentation, their descriptions can be condensed, with a link to the full explanation.

For example, currently, the verbose has docstrings like below

and it can be simplified to:

verbose  
    Select verbosity level. [See detailed explanation.]

This approach reduces the documentation length of wrappers, and makes wrapper-specific parameters more prominent.

TODO list

Here is a complete list of GMT common options (https://docs.generic-mapping-tools.org/latest/std-opts.html).

• -B
• -J
• -R
• -U Unused in PyGMT
• -V DOC: Add a page for common parameters in the Technical Reference section #3844 @seisman
• -X: Unused in PyGMT
• -Y: Unused in PyGMT
• -a
• -b
• -c
• -d
• -e
• -f
• -g
• -h
• -i
• -j DOC: Move description of distcal to the Technical Reference section #3868 @seisman
• -l
• -n
• -o
• -p
• -q
• -r
• -s
• -t
• -w
• -x
• -:

[yvonnefroehlich]

This approach seems to be similar to what is done in the GMT docs:

If I understand it correctly, this would replace the entries in the decorators file. And we can consider this to avoid writing duplicate code in Figure.meca and Figure.cope.

[seisman]

If I understand it correctly, this would replace the entries in the decorators file.

No, it won't replace the entries but can simplify them.

And we can consider this to avoid writing duplicate code in Figure.meca and Figure.cope.

This "Common parameters" page should only be used for common parameters shared by all GMT modules, so it won't solve the issue for Figure.meca/Figure.coupe.