Documenting python code with Sphinx?

Question

I have installed Sphinx and I want to create documentation for my module. When sphinx-quickstart command finished there is configuration for one Sphinx project. What I don't know is how to generate documentation for my module. Using 'make html' generates empty documentation. I read that index.rst is the main file, but I don't know how to tell Sphinx where is my module?

Curtis Scheer · Answer

Did you guys ever find a good solution to create odoo module documentation?

Yannick Oliver · Answer

Chances are high you haven't configured it properly. However, I think sphinx has to be able to run your python files and because sphinx cant import models from odoo, it won't be able to generate documentation for it. I'm also looking towards auto documentation for odoo.

相关帖文	回复	查看
Documenting python code with Sphinx? documentation python sphinx pythondoc	0 5月 21	5854
Private functions and public functions in odoo python 已解决 python odoo	3 2月 25	3539
odoo ghost module python odoo	0 5月 24	46
Call python method from inherit_id attribute python odoo	1 4月 24	3347
how Restrict users to see only his own invoice ? python odoo	4 9月 23	4830

此问题已终结

喜欢讨论吗？不要只阅读，加入进来！