Hi,
I am in the process of writing a custom Python API for my studio. I've been tasked with providing a documentation system to allow my colleagues to build their own tools based on our API base classes and functions. I have chosen Sphinx, as it is what Python uses to create their own docs online. Sphinx offers a very cool 'autodoc' extension that...well...automatically document your code based on your docstrings.
Sphinx -
http://sphinx.pocoo.org/index.htmlThe autodoc extenstion -
http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodocTHE PROBLEM:
Autodesk only provides the .pyc files for the cmds and mel packages. This poses a problem, as autodoc relies on importable .py files with docstrings.
PYMEL you say ?!?
That is a good solution, but I'd rather not rewrite the code, and I also don't want to get caught in a bind if pymel goes south or an application upgrade fries everything.
If anyone out there has ever gotten some sort of autodoc feature to work with anything else, please respond.
Thanks!!
-MT
