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.

Gerelateerde posts	Antwoorden	Weergaven
Documenting python code with Sphinx? documentation python sphinx pythondoc	0 mei 21	7578
Save filtered tree view to load as it is at another time Opgelost python odoo	2 aug. 25	4105
Private functions and public functions in odoo python Opgelost python odoo	3 feb. 25	5927
odoo ghost module python odoo	0 mei 24	46
Call python method from inherit_id attribute python odoo	1 apr. 24	5193

Deze vraag is gerapporteerd

Geniet je van het gesprek? Blijf niet alleen lezen, doe ook mee!