Create documentation using pydoc and unknown modules

Question

I'm afraid this will a question for a very particular case. At university we have been told to generate documentation by using pydoc. The problem is that we need to create it for a Maya script, and pydoc yells when it finds import maya.cmds as cmds

So, I tried to comment this line but I keep getting errors:

python C:\Python27\Lib\pydoc.py Script.py    
problem in Script - <type 'exceptions.NameError'>: global name 'cmds' is not defined

I also tried Script, without the extension .py but it's silly doing that, we still running around the same issue.

Does anybody know how to generate documentation for Maya scripts, where import maya only works in the maya interpreter?

I edited your question to be less specific to maya, and deal more with the general case, in hopes of attracting a wider audience. Feel free to roll back my edit if you prefer your original wording — mhlester
– mhlester, Commented Apr 8, 2014 at 0:09
@mhlester Thanks so much! You did a very nice job for me haha — Ramon Blanquer
– Ramon Blanquer, Commented Apr 8, 2014 at 0:10
@joojaa it does not work, it doesn't find pydoc. Thank you anyway :D — Ramon Blanquer
– Ramon Blanquer, Commented Apr 8, 2014 at 22:08
@RamonBlanquer Odd pydoc works fine for me with mayas own interpretter — joojaa
– joojaa, Commented Apr 15, 2014 at 12:06

theodox · Accepted Answer · 2014-04-08 17:36:45Z

maya.commands is an stub module until it's run inside a working maya environment; if you just import it and inspect it outside of Maya you'll see that it's basically a placeholder.

If you want to inspect the contents, you can import the maya.standalone module and initialize it before running other commands (in this case it means you won't be able to run pydoc standalone.

You can get the documentation using the write command:

 import maya.standalone
 maya.standalone.initialize()
 import pydoc
 import mymodule
 pydoc.write(mymodule) # writes the mymodule.html to current directory

Be warned, however, that the documentation for all maya built in functions will be unhelful:

 'built-in function ls'

however you can at least document your own stuff without the maya parts crashing.

Pydoc, ironically, does not have a lot of external documentation. However you can see the code here:http://hg.python.org/cpython/file/2.7/Lib/pydoc.py (i'm not sure about the delta between this and the 2.6 version for maya pre-2014 but it works as above in maya 2011)

Collectives™ on Stack Overflow

Create documentation using pydoc and unknown modules

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related