Skip to content
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

Merged
merged 9 commits into from
Jul 27, 2015

Conversation

leouieda
Copy link
Member

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

@leouieda leouieda added the docs label Jul 18, 2015
The PR docs couldn't find their CSS files because sphinx uses relative
paths. This is a hack to make sphinx insert the site url in front of
links to try to overcome this. A problem is that I cant overwrite the
css macro in the template. A work  around is to define the links again
with the url.
@leouieda
Copy link
Member Author

The gambiarra doesn't work. Maybe it's a problem with github pages?

UPDATE: The problem was that I didn't make a .nojekyll file in the root directory. Need to revert the gambiarra now.

@eusoubrasileiro
Copy link
Contributor

man I am manufacturing here my weeding invitations hhaah I am so proud of you: Saturday night and trying gambiarras that's the spirit

@eusoubrasileiro
Copy link
Contributor

where is Paper? hehe

@leouieda
Copy link
Member Author

@eusoubrasileiro she's out tonight and I was tired of my thesis 👺 BTW, check this out for your wedding: https://youtu.be/ZDK5DZOgHD8?t=19m2s and https://github.com/katyhuff/wedding

Place an alert box at the top of the page to warn that this is built by
a PR.
leouieda added a commit that referenced this pull request Jul 27, 2015
Trying out the maptlotlib plot_directive sphinx extension for the docs
@leouieda leouieda merged commit 5a20dd4 into master Jul 27, 2015
@leouieda leouieda deleted the plot-directive branch July 27, 2015 17:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants