This repository has been archived by the owner on Dec 22, 2021. It is now read-only.
Trying out the maptlotlib plot_directive sphinx extension for the docs #219
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 allows us to include plots in the doctests for modules, functions and classes. Plots are generated when the docs are compiled so they are guaranteed to be updated. This PR is more of a proof of concept. I've only made plots for the
gravmag.eqlayer
doctests as an example. Other PRs can start implementing this slowly.Here is what it looks like: http:https://www.fatiando.org/pull/219/api/gravmag.eqlayer.html#fatiando.gravmag.eqlayer.EQLGravity