I am considering epydoc for the documentation of one module. It looks ok to me and is working fine when I am generating html document. I would like to try to generate the documenation in the pdf format. I've just modified the 'output' setting in my config file. Unfortunately, epydoc fails when generating the pdf file. The error is "Er...
When I load my code into epydoc and just load the top module it fails with: Error: TypeError: 'NoneType' object is not callable (line 10) Where the the NoneType that it is referring to is a submodule that I tried to load on line 9. How can I get epydoc to explain why it couldn't load the module on line 9 instead of just plowing ahead...
I have a module containing multiple global functions, and a global variable. The variable and some of the functions follow the 'private' naming convention for Python, with a leading underscore for the name. The other functions are intended to be public, and do not have a leading underscore. I have declared __all__, with a list of my pub...
Hi, I have written a software component that relies on a configuration file. For clarity, I want to document the structure of the configuration file by adding an example file in the docstring of the relevant class. For obvious reasons, it should appear in fixed-width font. The only way I know is adding >>> before each line, which is ba...
I'm using reStructuredText with epydoc. How can I have the text of an internal link different than the target of the link? I have: :todo: Figure out the `Product.manufacturer` relationship in `Product`. The Product link looks fine and links to the Product object. The Product.manufacturer link goes to the proper member variable, but in...
I'm using EpyDoc (with reStructuredText) to document my Python project and produce HTML output. EpyDoc automatically truncates long lists of attributes in UML diagrams (generated with the --graph=umlclasstree option), helpfully placing a clickable ... marker that doesn't link to anything or seem to trigger any JavaScript events. For ex...
I have a pylons project with an extensive set of functional tests that I want my manual QA's to be able to read from time to time, so I'm using epydoc to build out the html pydocs on the functional test modules. It seems to be working fine. It generates the docs, and I can navigate through them without any apparent problems. However, ...