https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163885#M16241 Hi,<BR /><BR />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. <BR /><BR />Sphinx - <A href="http://sphinx.pocoo.org/index.html" target="_blank">http://sphinx.pocoo.org/index.html</A><BR /><BR />The autodoc extenstion - <A href="http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodoc" target="_blank">http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodoc</A><BR /><BR />THE PROBLEM:<BR /><BR />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.<BR /><BR />PYMEL you say ?!?<BR /><BR />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.<BR /><BR />If anyone out there has ever gotten some sort of autodoc feature to work with anything else, please respond.<BR /><BR />Thanks!!<BR /><BR />-MT Mon, 09 Aug 2010 17:59:26 GMT Anonymous 2010-08-09T17:59:26Z https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163885#M16241 Hi,<BR /><BR />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. <BR /><BR />Sphinx - <A href="http://sphinx.pocoo.org/index.html" target="_blank">http://sphinx.pocoo.org/index.html</A><BR /><BR />The autodoc extenstion - <A href="http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodoc" target="_blank">http://sphinx.pocoo.org/ext/autodoc.html#module-sphinx.ext.autodoc</A><BR /><BR />THE PROBLEM:<BR /><BR />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.<BR /><BR />PYMEL you say ?!?<BR /><BR />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.<BR /><BR />If anyone out there has ever gotten some sort of autodoc feature to work with anything else, please respond.<BR /><BR />Thanks!!<BR /><BR />-MT Mon, 09 Aug 2010 17:59:26 GMT https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163885#M16241 Anonymous 2010-08-09T17:59:26Z https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163886#M16242 Have you tried epydoc? I has an introspect-only option, and a runtime API, so it doesn't rely on parsing source code. Sat, 14 Aug 2010 17:40:19 GMT https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163886#M16242 Anonymous 2010-08-14T17:40:19Z https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163887#M16243 epydoc FTW! Thanks! Wed, 17 Nov 2010 19:56:24 GMT https://forums.autodesk.com/t5/maya-programming-forum/maya-python-and-sphinx-autodoc-features/m-p/4163887#M16243 Anonymous 2010-11-17T19:56:24Z