mrdoob/three.js — Issue #1307: Best practices for API documentation (using Sphinx)
Author: mrienstra
Created: 2012-02-10 23:56:16+00:00
State: open

Howdy,

I thought I'd take a stab at adding to the API documentation. Here is my first attempt:

* https://gist.github.com/1793969

I am aware of these existing discussions:

* https://github.com/mrdoob/three.js/pull/801
* https://github.com/mrdoob/three.js/pull/838

And also this RST reference that mrdoob linked to:

* http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html

I noticed that there is a little bit of variety in how the current RSTs are formatted. I'm guessing it would be wise to use the RSTs recently edited by alteredq as templetes, such as one of the following:

* https://github.com/mrdoob/three.js/blob/dev/docs/api/core/Color.rst
* https://raw.github.com/mrdoob/three.js/dev/docs/api/core/Face3.rst

I'd love to have a go-to reference, even if it's only "these are a few of the best RSTs we've done, use them as templates".