PySoy: Clean Docs Build
completed by: Matt Habel
mentors: Amaury Medeiros, Arc Riley, Tony Young, David Czech, Mayank Singh
PySoy uses Sphinx for documentation which can be built using the
setup.py build_docs command, however, there's currently several
errors and warnings when you do this such as;
docstring of soy.atoms.Position:18: ERROR: Unexpected indentation. docstring of soy.atoms.Rotation:8: ERROR: Unexpected indentation. docstring of soy.bodies.Box:7: WARNING: Block quote ends without a blank line; unexpected unindent. docstring of soy.bodies.Sphere:8: WARNING: Block quote ends without a blank line; unexpected unindent.
Fix these so the docs build cleanly and properly. You'll need to start by building libsoy and PySoy from Mercurial and then editing PyDoc strings in the files producing these errors. Rebuilding PySoy will test your fixes.
While working on this task you should join and remain in #PySoy on Freenode to get help, feedback, and guidance from mentors and other developers. Code updates which may affect your work are also announced here as they happen.
When you've done, commit your work and post the resulting changeset url to this task.