You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Odoo Translation Bot d091840e34 [I18N] Update translation terms from Transifex 5 days ago
.tx [I18N] export 11.0 source terms 1 year ago
_extensions [FIX] _extension: complete monkeypatch in sphinx 1.6 1 week ago
_static [FIX] accounts unbalanced in continental accounting for stock transactions 2 months ago
accounting [FIX] accounting: foreign currency 1 month ago
crm [FIX] crm: Fix typo in acquire_leads.rst 1 year ago
db_management [IMP] db_management: update screenshot to v11 uninstall wizard 1 year ago
discuss [FIX] discuss : typos + wording and wrong link email_servers 1 year ago
ecommerce [FIX] paypal: documentation for EWP (#396) 1 month ago
expense [IMP] expense: Update doc flow to v11 2 years ago
general [IMP] crm: Whole documentation overhaul 1 year ago
getting_started [FIX] getting_started/documentation: dead link 2 months ago
helpdesk [ADD] helpdesk: Record and invoice time for tickets 1 year ago
inventory [MERGE] Forward-port of 10.0 up to 2a17601b52c80e8e52bd5916fe1d16fa91326bd1 1 month ago
legal [FIX] legal: typo in partnership contract 3 months ago
livechat [FIX] livechat: Display options in bold 1 year ago
locale [I18N] Update translation terms from Transifex 5 days ago
manufacturing [FIX] manufacturing : bill of material fix wrong direction 1 year ago
mobile [ADD] mobile: Setup your Firebase Cloud Messaging 1 year ago
odoo_sh [FIX] odoo_sh: typo 1 month ago
point_of_sale [FIX] point_of_sale: POSBoxless 5 months ago
portal [ADD]Documentation: added new section eplaining My Account 1 year ago
project [FIX] project: update link to non-existant section 1 year ago
purchase [FIX] purchase: remove reference to old page 5 months ago
sales [IMP] sale: Rewrite the 'Invoicing Method' subsection 1 year ago
website Update SSL doc for the saas 2 months ago
.gitignore [FIX] a pair of leftover warnings 1 year ago
Makefile [IMP] latex: copy PDF files next to HTML output 3 years ago
README.rst [IMP] README bits 4 years ago
accounting.rst [ADD] accounting: Switzerland Accounting Localization 2 years ago
applications.rst [MERGE] Forward-port of 10.0 up to 2a17601b52c80e8e52bd5916fe1d16fa91326bd1 1 month ago
business.rst [FIX] mementoes: Fix some terms/computation/links 2 years ago
conf.py [IMP] legal: backport latest changes from 12.0 3 months ago
crm.rst [IMP] crm: Whole documentation overhaul 1 year ago
discuss.rst [ADD] discuss: Get organized by planning activities 1 year ago
ecommerce.rst [ADD] ecommerce: New app section 3 years ago
general.rst [ADD] general: How to allow users to sign in with their Google account 2 years ago
helpdesk.rst [ADD] helpdesk: Record and invoice time for tickets 1 year ago
index.rst [ADD] link to business memento 2 years ago
inventory.rst [IMP] inventory: make the structure consistent with the 'Odoo 9 Documentation' spreadsheet 4 years ago
legal.rst [IMP] legal: backport latest changes from 12.0 3 months ago
manufacturing.rst [IMP] manufacturing: Restructure pages 1 year ago
point_of_sale.rst [ADD] point_of_sale: belgian fiscal data module documentation 3 years ago
practical.rst [ADD]Documentation: added new section eplaining My Account 1 year ago
project.rst [IMP] Remove empty pages from TOCs 3 years ago
purchase.rst [ADD] purchase: How to setup a minimum stock rule? 4 years ago
sales.rst [ADD] sales: Use quotation templates 1 year ago
website.rst [ADD] website: How to track your traffic through Google Analytics 3 years ago

README.rst

===========================
End-user Odoo documentation
===========================

Building requirements:

* Python 2.7
* recent `Sphinx <http://sphinx-doc.org>`_ (at least Sphinx 1.2)

you can check if Sphinx is installed by trying to launch

.. code-block:: console

$ sphinx-build --version

See `the sphinx documentation <http://sphinx-doc.org/install.html>`_
for local installation instructions.
* `git <http://www.git-scm.com>`_
* clone this repository using git, then at the root of the repository,
in a console,

.. code-block:: console

$ make html

this should compile the documentation to HTML, and put the generated
HTML in ``_build/html/index.html``.

Contributions
=============

For simple edition (typo, just add paragraphs of text without markup),
the Github web interface can be used directly.

For more complex edition, to add images or advanced directives, edit
locally. **Do not commit if there are warnings or errors when building
the documentation** fix them first. rST is fairly sensitive to
whitespace and newlines (especially the lack of newlines). It's a bit
annoying but it's not hard to learn.

Issues can be reported on the repository's bug tracker as usual.

Custom features
===============

Extensions
----------

Two custom directives are provided for integration with Odoo's demo
system:

* ``demo:fields:: {external_id}`` lists all the fields with a
tooltip (``help``) of the action whose ``external_id`` is provided.

- Uses the ``form`` view by default, can be customized by specifying
``:view:``.
- The list of fields displayed can be filtered with ``:only:`` which
should be a list of space-separated fields to display. Note that
this will further reduce the number of fields displayed, it will
not force fields to be listed when they don't have a ``help``.

.. code-block:: restructuredtext

.. demo:fields:: account_asset.action_account_asset_asset_list_normal_sale
:only: name

will display a table of just the ``name`` field and its ``help`` (or
nothing if the ``name`` field does not have a ``help``)

* ``demo:action:: {external_id}`` will create a link button to the
action (specified by external id) on the demo site. The text of the
button should be provided as the directive's content:

.. code-block:: restructuredtext

.. demo:action:: account_asset.action_account_asset_asset_list_normal_sale

View *Asset Types*

Theme Customisations
--------------------

* The Odoo theme supports *Banner Images* at the top of
documents. These banners are configured by setting a ``:banner:``
field at the top of the document (before the page title), the banner
images will be looked up in the ``_static`` folder at the root of
the project

.. code-block:: restructuredtext

:banner: banners/accounting.png

==========
Accounting
==========

[...]

.. warning::

because banners are wide images and each page may have one, it is
strongly recommended to compress them well. For PNG, use
`pngquant <https://pngquant.org>`_ (or a UI to it) to reduce the
number of colors in the image followed by regular PNG
recompression tools like `pngcrush
<http://pmt.sourceforge.net/pngcrush/>`_ and `pngout
<http://www.advsys.net/ken/util/pngout.htm>`_.



Importing existing documents
============================

For documents which already exist in an other format or in Google
docs, it's possible to get a head-start by converting the existing
document using `Pandoc <http://pandoc.org>`_. The main issue is that
anything but trivial original documents will need fixing up (possibly
lots of it) to get *good* rST (or possibly working rST at all).

Example::

pandoc -f docx -t rst path/to/document.docx -o new_doc.rst --extract-media=.

will convert ``path/to/document.docx`` to ``new_doc.rst`` and export
all images to ``./media`` (and link them from the document). While
there are issues with the exported document, it's much more convenient
than manually re-typing the original.