Refine the documentation for public API and extending papermill

nteract / papermill

📚 Parameterize, execute, and analyze notebooks

http://papermill.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

5.71k stars 420 forks source link

Open willingc opened 5 years ago

willingc commented 5 years ago

In light of #360, #354, it would be good to do a pass through the documentation to be a bit more explicit about extending engines, io, storage.

[ ] Split up the workflow API doc into separate pages and annotate a bit more
[ ] Incorporate/reference the design document DEVELOPMENT_GUIDE.md
[ ] Add to release checklist to publish RTD documentation version to match releases
[x] Publish 1.0.0 Documentation

MSeal commented 5 years ago

This would be great!