Contributors mailing list archives

contributors@odoo-community.org

Avatar

Re: Odoo automatic code documentation

by "joergl" <joergl@itis.de> - 07/07/2021 12:00:14
Dear, Tom, Daniel and David,

Many thanks for your replies. 

Generally it does work this way, and it nicely reveals which coding  artist is doing what amount of documentation to the extent of readability for the other developers. 

However, we went into an issue, when it comes to recursions: here the running of the Python code is frequently running into an endless loop.

Is there any kind of switch in odoo, that prevents this behavior like "maximum depth of recursion loops"


Best, Joe


-------- Ursprüngliche Nachricht --------
Von: Daniel Reis <dreis@opensourceintegrators.com>
Datum: 24.06.21 15:17 (GMT+01:00)
An: Contributors <contributors@odoo-community.org>
Betreff: Re: Odoo automatic code documentation

Hello,

Try "cd /path/to/odoo && pip install ."
You will then be able to "import odoo"

Thanks
Daniel

On 24/06/2021 09:42, Joerg Lorenz wrote:
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 ...

  • PyDoc, a documentation browser (in HTML) and/or an off-line reference manual. Also in the standard library as pydoc.

  • pydoctor, a replacement for now inactive Epydoc, born for the needs of Twisted project.

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

If anyone has some experience, ideas, or pointer towards a solution, it would be highly appreaciated. 

Best, Joe

_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe


--
Daniel Reis
Managing Director
M: +351 919991307
E: DReis@OpenSourceIntegrators.com
Av. Republica 3000, Edificio Estoril Office, B Piso 3 - 34 • 2649-517 Alcabideche, Portugal


_______________________________________________
Mailing-List: https://odoo-community.org/groups/contributors-15
Post to: mailto:contributors@odoo-community.org
Unsubscribe: https://odoo-community.org/groups?unsubscribe