Community mailing list archives
community@mail.odoo.com
Browse archives
implementing - gitchangelog to odoo and its modules
byRobert:
What do you think about Odoo implementing something like gitchangelog: "use your commit log to make beautiful and configurable changelog file"?
It's compatible with Python 2/3, works on Linux/BSD/MacOSX, and it's default output is ReSTructured text (which is what the doc's are using now).
It could be made to fit nicely with Odoo's Commit message conventions, assuming they were expanded (SEE "Action", "Audience", "Tags"), and would address some of your concerns:
"the actual documentation was a huge source of frustration. Just this week one of my office colleagues who tried to learn how to create a web site creator snippet gave up in frustration. The documentation is just wrong ..
And I learned myself that the JavaScript API documentation is mostly V8 based and of little value for V9. Unless, of course you know what has changed between v8 and v9. For which I found no documentation at all.."
Developers could review these and update their modules and Odoo's documentation.
R/S
Again.
Read the code please!, do not make statements just because people does not look in the right place.
Folder doc into the mail module:
https://github.com/odoo/odoo/tree/9.0/addons/mail/doc
Here:
https://github.com/odoo/odoo/blob/9.0/addons/mail/doc/tracked_field.rst
You can improve what you actually know and make a PR "It is very welcome".
Regards.
- The documentation which Nhomar mentions does not help a lot with localise actual changes
- Cody mentioned a very good solution to fix actually that problem.
- It would be great to have that integrated in Odoo.
Sphinx Python Documentation Generator and Viewer
Installs a full-fledged Sphinx environment within your TYPO3 website. Builds and renders Sphinx/reStructuredText-based projects such as extension manuals, official reference guides or your own in-house documents as HTML/JSON/PDF either from TYPO3 Backend or from command-line, as you prefer. Features a reStructuredText editor with cross-reference browser and syntax highlighting.
Sphinx Documentation Viewer Plugin
Seamlessly embeds Sphinx/reStructuredText-based documentation into your TYPO3 website. Instead of publishing your various manual, in-house documents, guides, references, ... solely as PDF, render them as JSON and use this extension to show them as part of your website to enhance the overall user experience and Search Engine Optimization (SEO). Lets you merge the chapter structure with the breadcrumb menu and much more. Documentation styles automatically inherit from your corporate design.
==========
Andi
Follow-Ups
-
-
Re: implementing - gitchangelog to odoo and its modules
byXOE Corp. SAS, David Arnold -
Re: implementing - gitchangelog to odoo and its modules
byredCOR AG, robert rottermann -
-
-
-
Re: implementing - gitchangelog to odoo and its modules
byVauxoo S.A. de C.V., Nhomar Hernandez -
Re: implementing - gitchangelog to odoo and its modules
byredCOR AG, robert rottermann -
Re: implementing - gitchangelog to odoo and its modules
byVauxoo S.A. de C.V., Nhomar Hernandez -
Re: implementing - gitchangelog to odoo and its modules
byredCOR AG, robert rottermann