Create code documentation

[rodluger]

Uff...

[jlustigy]

What do you want me to do here? I know our styles of code documentation are slightly different. Should I make mine like yours?

On Fri, Jul 21, 2017 at 7:54 PM, Rodrigo Luger notifications@github.com wrote:

Assigned #35 https://github.com/rodluger/planetplanet/issues/35 to @jlustigy https://github.com/jlustigy.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rodluger/planetplanet/issues/35#event-1174760253, or mute the thread https://github.com/notifications/unsubscribe-auth/AIeJIhZJgoDKiCs_nkad1KSfIvsButQ0ks5sQWRvgaJpZM4OgDBx .

-- Jacob Lustig-Yaeger Astronomy & Astrobiology Graduate Student University of Washington jlustigy.github.io

[rodluger]

I'm going to use Sphinx autodoc, so it needs to follow a certain style. Check out my docstrings for functions/methods:

def Function(*args, **kwargs):
  '''

  A brief description of the function.

  :param str name: A unique identifier for this planet
  :param float m: Mass in Earth masses. Default `1.`
  :param array_like foo: Bla bla bla. Default `1.`

  '''

At the top of every file I add

'''
:py:mod:`script.py` - Description of script
-------------------------------------------

'''

[rodluger]

Created the docs/ directory and started adding sphinx stuff to it.

[rodluger]

Done commenting all the API. Now on to making a "quick start" tutorial.

[rodluger]

Done creating the quick start tutorial. @jlustigy can you add a brief tutorial on using your code there?