Embedded documentation per module.
Why embedded documentation per module
1) The writer of module, can write the document at the same time, in english and this own language
2) There are a lot of contributors for module, not just OpenERP Team
3) There are accessible in local
4) it can complete with a wiki for describe an internal procedure
How to:
---------
In a module (test.test object per example) add a new directory
./document
it containt a file per object and per language
test.test-
test.test-
....
How to write source documentation:
1) Docbook
2) Rst
3) ?
and use for docbook a XSLT stylesheet
and add section in __terp__.py
"document" = ["en_US","fr_FR"]
Blueprint information
- Status:
- Complete
- Approver:
- None
- Priority:
- Undefined
- Drafter:
- None
- Direction:
- Needs approval
- Assignee:
- None
- Definition:
- Obsolete
- Series goal:
- None
- Implementation:
-
Deferred
- Milestone target:
- None
- Started by
- Completed by
- Fabien (Open ERP)
Related branches
Related bugs
Sprints
Whiteboard
The problem of the documentation process is not at all where to store it and how to generate final document. The real problem is who will write documentation and who will translate and maintain. This suggestion does not solve the problem at all. And it's the opposite; by making the process more technical, you don't allow good writers (not developers) to contribute.
Here is the process we will follow:
* http://
A documentation in a module can not be as good as a book. Think about an accountant that needs a documentation/
This suggestion may apply on the technical documentation, but for this, I wonder if it'not better to use traditionnal tools with __doc__ in python ?
