Sphinx extensions for the Generic Mapping Tools

Convert this:

.. gmtplot::
    :language: bash
    :show-code: false
    :caption: GMT plot automatically generated and included by the sphinx extension 🚀

    gmt pscoast -Rg -JW10i -Baf -Ggray > globe.ps

into this:

Source Code

_images/ddcde16e9dd45844fe77f0a9ae4ce283.png — GMT plot automatically generated and included by the sphinx extension 🚀

About

This package provides a Sphinx extension for including GMT code and figures in your documentation. The extension defines the gmtplot directive that will execute the given code and insert the generated figure into the document (like the matplotlib plot directive).

Features

Supports any GMT versions
Works with both Bash and Python (PyGMT)
Include code inline or load from a script
Options to show/hide the code, insert captions, link to hidden code, etc.

Contacting Us

Most discussion happens on Github. Feel free to open an issue or comment on any open issue or pull request.

Contributing

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing Guidelines

Please read our Contributing Guide to see how you can help and give feedback.

Imposter syndrome disclaimer

We want your help. No, really.

There may be a little voice inside your head that is telling you that you’re not ready to be an open source contributor; that your skills aren’t nearly good enough to contribute. What could you possibly offer?

We assure you that the little voice in your head is wrong.

Being a contributor doesn’t just mean writing code. Equality important contributions include: writing or proof-reading documentation, suggesting or implementing tests, or even giving feedback about the project (including giving feedback about the contribution process). If you’re coming to the project with fresh eyes, you might see the errors and assumptions that seasoned contributors have glossed over. If you can write any code at all, you can contribute code to open source. We are constantly trying out new skills, making mistakes, and learning from those mistakes. That’s how we all improve and we are happy to help others learn.

This disclaimer was adapted from the MetPy project.

License

This is free software: you can redistribute it and/or modify it under the terms of the BSD 3-clause License. A copy of this license is provided in LICENSE.txt.