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.

Related Posts	Replies	डेटा देखने का तरीका
Documenting python code with Sphinx? documentation python sphinx	0 मई 21	7786
Save filtered tree view to load as it is at another time Solved python odoo	2 अग॰ 25	4289
Private functions and public functions in odoo python Solved python odoo	3 फ़र॰ 25	6155
odoo ghost module python odoo	0 मई 24	46
Call python method from inherit_id attribute python odoo	1 अप्रैल 24	5484

This question has been flagged

Enjoying the discussion? Don't just read, join in!