Hi friends, this group is making a great job supporting web2py users. I don't use to ask many questions because it's easy to find them already solved.
I would like to use Sphinx to document an application developed with web2py 2.12.1. I mean using docstrings in controllers and models. As web2py documentation is generated with Sphinx I thought it would be easy. I searched for directions on how to do it, but only found a seemingly old page http://www.web2py.com/examples/static/sphinx/docs_contrib.html, and some discussions in web2py-users group about migrating web2py api to Sphinx, but no information about how to document applications. Then I tried by myself, and was able to reference some controller with autodoc, setting PYTHONPATH to controllers and models folder, i.e. default controller: Welcome to Project's documentation! ================================= Contents: .. toctree:: :maxdepth: 2 .. automodule:: default :members: But now I'm getting some error when generating the documentation: .../web2py_2.12.1/applications/FyEPrototipo/doc/index.rst:14: WARNING: autodoc: failed to import module u'default'; the following exception was raised: Traceback (most recent call last): File "/usr/lib/python2.7/dist-packages/sphinx/ext/autodoc.py", line 335, in import_object __import__(self.modname) File ".../web2py_2.12.1/applications/FyEPrototipo/controllers/default.py", line 72, in <module> @auth.requires_membership('orientacion') NameError: name 'auth' is not defined Also tried to add gluon in PYTHONPATH to no avail. Seems to be some problem with the decorator. Any hint would be greatly appreciated. Thanks in advance. Best regards. -- Resources: - http://web2py.com - http://web2py.com/book (Documentation) - http://github.com/web2py/web2py (Source code) - https://code.google.com/p/web2py/issues/list (Report Issues) --- You received this message because you are subscribed to the Google Groups "web2py-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
