Skip to content

Conversation

wholmgren
Copy link
Member

This PR adds a ModelChain tutorial to the documentation.

I'm trying a different documentation build technique than I've used in the past: write the tutorial in a Jupyter notebook, then use nbsphinx to embed it in the html documentation. After a few hiccups, I found that overall it's a lot easier than writing rst files with ipython directives. The downside is that the source ipynb file is harder to read with a simple text editor (or on github) than a simple rst file. The ipynb file doesn't have any output, though, so it's not as bad as it can be.

You can few the documentation here:

http://wholmgren-pvlib-python-new.readthedocs.io/en/mcdocs2/modelchain.html

I'll leave this open for a day for edits/suggestions. We can always improve it later, too.

@wholmgren wholmgren added this to the 0.5.0 milestone Aug 9, 2017
@wholmgren wholmgren merged commit 95fe1f6 into pvlib:master Aug 11, 2017
@wholmgren wholmgren deleted the mcdocs2 branch September 9, 2017 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant