doc/index.rst

   1 ============================
   2 odoo developer documentation
   3 ============================
   4
   5 Welcome to the Odoo developer documentation.
   6
   7 This documentation is incomplete and may contain errors, if you wish to
   8 contribute, every page should have a :guilabel:`View on Github` link:
   9
  10 .. image:: images/view-on-github.*
  11     :align: center
  12
  13 Through this link you can edit documents and submit changes for review using
  14 `github's web interface
  15 <https://help.github.com/articles/editing-files-in-your-repository/>`_.
  16 Contributions are welcome and appreciated.
  17
  18 .. todo:: what's the documentation's license?
  19
  20 The documentation is currently organized in four sections:
  21
  22 * :doc:`tutorials`, aimed at introducing the primary areas of developing Odoo
  23   modules
  24 * :doc:`reference`, which ought be the complete and canonical documentation
  25   for Odoo subsystems
  26 * :doc:`modules`, documenting useful specialized modules and integration
  27   methods (and currently empty)
  28
  29 .. hidden toctree w/o titlesonly otherwise the titlesonly "sticks" to
  30    in-document toctrees and we can't have a toctree showing both "sibling"
  31    pages and current document sections
  32
  33 .. toctree::
  34     :hidden:
  35
  36     tutorials
  37     reference
  38     modules
  39
  40 .. ifconfig:: todo_include_todos
  41
  42     .. rubric:: Things to add and fix
  43
  44     .. todolist::