Document the environment variables that can affect the behavior of PyGMT #3432
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seisman
added
documentation
seisman
changed the title
doc/techref/environment_variables.md
Outdated
|
|
||
| PyGMT's behavior can be controlled through various environment variables. These variables | ||
| can be set either in your shell environment or within your Python script using the | ||
| :py:data:`os.environ` dictionary. |
There was a problem hiding this comment.
Setting the link like this does not work correctly.
I tried :py:func:, :py:class:, :py:, but with no success. Maybe we have to do it like:
Suggested change
| :py:data:`os.environ` dictionary. | |
| [`os.environ`](https://docs.python.org/3/library/os.html#os.environ) dictionary. |
There was a problem hiding this comment.
Thanks for catching it. Fixed in 7ed1300. py:data is correct. Just need to use the MyST Markdown syntax, not the ReST syntax.
seisman
added
final review call
|
will merge in 24 hours if no further comments. |
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
seisman
removed
the
final review call
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds another page to the "Technical Reference" section. On this page, the environmental variables that PyGMT uses are documented. There are still many other variables that are not documented since they are not explicitly used by PyGMT (e.g.,
HOME,GMT_SHAREDIR). We may document them later.Preview: