Community mailing list archives

community@mail.odoo.com

Re: Reflection about documentation.

by
Fabien Pinckaers (fp)
- 08/13/2014 14:01:24

On 08/13/2014 07:02 PM, David Arnold wrote:
> ​@ Fabien: A clean *and* branded​ rtfd
> theme: http://docs.ansible.com/intro.html

The reason is not only about the CSS but also:
- drive traffic to our website (strong motivation for us to write docs)
- a unified experience for visitors (same menus, smooth navigation
  across the website)
- control for: API doc (may be a dynamic doc like facebook API),
  adding some plugins for auto-generated doc to sphinx [1]

[1] We had to develop this
https://pypi.python.org/pypi/sphinx-patchqueue/0.3.0 to build our sphinx
doc.

May be the solution is to simply host readthedoc to easily contribute to it.


-- 
Fabien Pinckaers
Odoo Founder

Phone: +32.81.81.37.00
Web: https://www.odoo.com
Twitter: @fpodoo

Instant Demo: https://odoo.com/start