I've started working on Sphinx documentation for the physics submodule:

https://github.com/hazelnusse/sympy/tree/sphinx_physics

There are three main items to work on:

1)  physics -- top level sympy/physics files
2)  quantum -- sympy/physics/quantum files
3)  mechanics -- sympy/physics/mechanics files

The documentation for all these lives in
sympy/doc/src/modules/physics.  In that directory, I've added stubs
for each of these items.  Gilbert and I are going to work on mechanics
documentation and I have something started for units.py, but it would
be great for those who know more about the other top level physics
files and the quantum stuff to give feedback or maybe even links to
example scripts that could be turned into Sphinx documentation without
too much effort.  There is a lot of stuff in quantum, it would be
really great to get some documentation for it into the Sphinx site.

I'm not sure what the best way to coordinate all of this is, does
pushing the skeleton of the documentation for this submodule into the
master branch make sense so that the basic framework is there and then
people can build on it, or should it all be done separately and once
it is polished then push it in as a whole?

~Luke

-- 
You received this message because you are subscribed to the Google Groups 
"sympy" group.
To post to this group, send email to sympy@googlegroups.com.
To unsubscribe from this group, send email to 
sympy+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sympy?hl=en.

Reply via email to