Contributors mailing list archives
Re: Odoo automatic code documentationby
Am sure that it can also be achieved easily without using those frameworks, using 'pip install' directly, but I didn't try...
Hi Guys, today we are asking for your insightfullness.Our quest: how the python code of odoo can be automatically documented from the code itself.
But the approach with the various toos that there are fails:
We have tested:
pdoc, a simple Python 3 command line tool and library to auto-generate API documentation for Python modules. Supports Numpydoc / Google-style docstrings, doctests, reST directives, PEP 484 type annotations, custom templates ...
pdoc3, a fork of pdoc for Python 3 with support for Numpydoc / Google-style docstrings, doctests, LaTeX math, reST directives, PEP 484 type annotations, custom templates ...
pydoctor, a replacement for now inactive Epydoc, born for the needs of Twisted project.If anyone has some experience, ideas, or pointer towards a solution, it would be highly appreaciated.and all of them fail. It has to do that odoo as such is not a python module itself and thus cannot be imported.
problem in models/res_company.py - <type 'exceptions.ImportError'>: No module named odoo