Clone or download
Permalink
Failed to load latest commit information.
.tx [I18N] export v12 documentation source terms Oct 19, 2018
_extensions [FIX] a pair of leftover warnings Aug 31, 2018
_static [MERGE] Forward port of 11.0 up to bcce8b4 Sep 19, 2018
accounting [ADD] accounting: add colombian localization docs Oct 2, 2018
crm [FIX] crm: Fix typo in acquire_leads.rst Apr 10, 2018
db_management [IMP] db_management: update screenshot to v11 uninstall wizard Aug 29, 2018
discuss [MERGE] Forward port of 11.0 up to bcce8b4 Sep 19, 2018
ecommerce [ADD] ecommerce: How to get paid with Authorize.Net Jun 7, 2017
expense [IMP] expense: Update doc flow to v11 Sep 18, 2017
general [IMP] crm: Whole documentation overhaul Apr 4, 2018
getting_started [IMP] getting_started: Support documentation Jul 26, 2018
helpdesk [ADD] helpdesk: Record and invoice time for tickets Mar 7, 2018
inventory [FIX] inventory: remove reference to removed page May 7, 2018
iot [ADD] iot: Connect an IoT Box to your database Sep 20, 2018
legal [FIX] most warnings Aug 31, 2018
livechat [FIX] livechat: Display options in bold Feb 27, 2018
locale [I18N] Update translation terms from Transifex Oct 19, 2018
manufacturing [MERGE] Forward port of 11.0 up to bcce8b4 Sep 19, 2018
mobile [ADD] mobile: Setup your Firebase Cloud Messaging Sep 6, 2018
odoo_sh [FIX] odoo_sh: broken link Sep 17, 2018
point_of_sale [FIX] point_of_sale: remove index of no existant page Oct 19, 2018
portal [ADD]Documentation: added new section eplaining My Account May 4, 2018
project [FIX] most warnings Aug 31, 2018
purchase [IMP] purchase: Update setup_stock_rule to 12.0 May 11, 2018
sales [IMP] sale: Rewrite the 'Invoicing Method' subsection Sep 19, 2018
website [IMP] website: removes obsolete documentation May 7, 2018
.gitignore [FIX] a pair of leftover warnings Aug 31, 2018
Makefile [IMP] latex: copy PDF files next to HTML output May 25, 2016
README.rst [IMP] README bits Jul 14, 2015
accounting.rst [ADD] accounting: Switzerland Accounting Localization Apr 3, 2017
applications.rst [MERGE] Forward port of 11.0 up to bcce8b4 Sep 19, 2018
business.rst [FIX] mementoes: Fix some terms/computation/links Jun 23, 2017
conf.py [ADD] documentation will be translated in Ukranian too now Aug 23, 2018
crm.rst [IMP] crm: Whole documentation overhaul Apr 4, 2018
discuss.rst [ADD] discuss: Get organized by planning activities Mar 7, 2018
ecommerce.rst [ADD] ecommerce: New app section Sep 21, 2016
general.rst [ADD] general: How to allow users to sign in with their Google account Jan 3, 2017
helpdesk.rst [ADD] helpdesk: Record and invoice time for tickets Mar 7, 2018
index.rst [ADD] link to business memento Jun 16, 2017
inventory.rst [IMP] inventory: make the structure consistent with the 'Odoo 9 Docum… Nov 4, 2015
iot.rst [ADD] iot: Connect an IoT Box to your database Sep 20, 2018
legal.rst [ADD] legal/terms: add NL translation of enterprise contract Jun 21, 2018
manufacturing.rst [ADD] manufacturing: Repair management May 9, 2018
point_of_sale.rst [ADD] point_of_sale: belgian fiscal data module documentation Dec 16, 2015
practical.rst [ADD]Documentation: added new section eplaining My Account May 4, 2018
project.rst [IMP] Remove empty pages from TOCs Dec 8, 2015
purchase.rst [REM] purchase: From purchase order to invoice and receptions Mar 8, 2018
sales.rst [ADD] sales: Use quotation templates May 16, 2018
website.rst [ADD] website: How to track your traffic through Google Analytics Sep 21, 2016

README.rst

End-user Odoo documentation

Building requirements:

  • Python 2.7

  • recent Sphinx (at least Sphinx 1.2)

    you can check if Sphinx is installed by trying to launch

    $ sphinx-build --version

    See the sphinx documentation for local installation instructions.

  • git

  • clone this repository using git, then at the root of the repository, in a 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.
    .. 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:

    .. 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

    :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 (or a UI to it) to reduce the number of colors in the image followed by regular PNG recompression tools like pngcrush and pngout.

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. 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.