Search code examples
documentationpython-3.xdocumentation-generation

Documentation generator for python3


I recently felt the urge to generate documentation for my little project. I thought it would be fairly easy since I had a set of nice docstrings. Turns out the whole process is much more complicated in python 3.1.

Here's what I tried:

  • epydoc: Fails because it's for python 2. 2to3 didn't solve the problems
  • pydoc: I can't find any information how can you generate documentation for your own modules, seems like a server for reading python docs offline
  • sphinx: Most promising so far, I have built it from their repository however it fails with a very cryptic error message (jinja2.exceptions.UndefinedError: b'b"\'sphinx.jinja2glue.idgen object\' has no attribute \'next\'")

My question is: what should I do now? Are there any other non-commercial documentation generators that work with python3?


Solution

  • Apparently in Jinja, something is doing X.next(). In Python 3 that's next(x) instead. It should be a simple fix.