forked from sunpy/sunpy
-
Notifications
You must be signed in to change notification settings - Fork 1
Documentation Sprint 2013
Stuart Mumford edited this page Nov 29, 2013
·
7 revisions
This page holds information and stuff relating to the Documenation Sprint on the 29th November 2013.
The workflow for the sprint is:
- there is a feature branch on the main SunPy repo where all doc work and PRs should be aimed during the day.
- We will have a PR session every 3 hours were people should send PRs and we can review and merge them. The idea of this is to keep a running copy of what the docs look like.
- Obviously PRs are welcome at other times throughout the day.
Tips:
- PR often and commit even more
- Claim an issue / task before you start working on it
- Join IRC(#SunPy on irc.freenode.net) and the Google + hangout
The user guide section and the gallery are the main targets.
Guide for numpydoc doc strings: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
Useful guidelines and info on the sphinx extensions: http://docs.astropy.org/en/stable/development/docguide.html