Odoo documentation sources
Go to file
Valentino d1e81b4052
[ADD] Minor change - Webinars on top l10n_ar
l10n_co (Colombia):

The change is due to a request to add webinars we had per localization to improve the visibility of this as a tool both for customers and Odooers. Why at the beginning? This is because is the first thing you see when accessing the documentation.

This is a minor change.
2021-01-14 16:34:51 -08:00
_extensions [MERGE] Forward port 12.0 to 13.0 2020-06-25 09:45:37 +02:00
_static [ADD] sign: document the validity of e-signatures 2020-12-22 11:55:32 +01:00
.github [ADD] .github: introduce code-owners file for reviewers 2020-04-16 11:31:20 +02:00
.tx [I18N] update 13.0 source terms 2020-03-19 13:05:28 +01:00
accounting [ADD] Minor change - Webinars on top l10n_ar 2021-01-14 16:34:51 -08:00
contributing [FIX] accounting,contributing: remove broken link and fix typo 2020-12-22 11:35:16 +01:00
crm [MOV] general: moving VoIP docs from "CRM" to "general" 2020-11-17 13:33:36 +01:00
db_management [MERGE] Forward-port of branch 12.0 to 13.0 2020-12-22 11:38:53 +01:00
discuss [FIX] discuss: couple of grammar points fixed 2020-10-06 10:22:20 +02:00
ecommerce [IMP] accounting: add new version of doc about taxes (#703) 2020-06-25 12:32:02 +02:00
email_marketing [IMP] discuss: documentation updated (#655) 2020-06-04 08:45:29 +02:00
events [ADD] events: add documentation (#702) 2020-07-22 17:01:09 +02:00
expense [IMP] accounting: add new version of doc about taxes (#703) 2020-06-25 12:32:02 +02:00
fsm [IMP] improved screenshots on email_marketing, events, fsm, general, helpdesk, marketing_automation, planning, project, sms_marketing, social_marketing, survey, timesheets + add see also in integrations_and_templates.rst (#677) 2020-05-19 09:12:45 +02:00
general [ADD] general: new documentation about Axivox as VoIP provider 2020-11-17 13:33:36 +01:00
getting_started [FIX] *: fix incorrect/unstable links 2020-01-15 10:52:05 +01:00
helpdesk [ADD] helpdesk: documentation about elearning/forum/rating features (#673) 2020-06-11 17:36:10 +02:00
inventory [IMP] Inventory: removal strategies' doc imp (#744) 2020-11-13 15:47:26 +01:00
iot [FIX] iot: Update and fix IoT documentation (#775) 2020-10-21 16:28:35 +02:00
legal [FIX] legal/terms: typo in quoting of cloc command 2020-08-04 20:12:07 +02:00
livechat [IMP] live_chat: overhaul documentation update (#601) 2020-03-27 15:44:57 +01:00
locale [I18N] Update translation terms from Transifex 2021-01-10 01:30:35 +01:00
manufacturing [IMP] MRP: Improvement of the subcontracting doc (#648) 2020-04-21 13:24:38 +02:00
marketing_automation [IMP] improved screenshots on email_marketing, events, fsm, general, helpdesk, marketing_automation, planning, project, sms_marketing, social_marketing, survey, timesheets + add see also in integrations_and_templates.rst (#677) 2020-05-19 09:12:45 +02:00
mobile [IMP] *: update banners 2020-02-06 17:15:02 +01:00
odoo_sh [MERGE] Forward-port of branch 12.0 to 13.0 2020-12-22 11:38:53 +01:00
planning [IMP] planning: send_planned_shifts.rst fix typo (#736) 2020-08-12 13:46:38 +02:00
point_of_sale [IMP] Point of Sale: Six >< Worldline (#732) 2020-07-31 10:55:48 +02:00
portal [FIX] portal: fix badly formatted ref 2020-10-14 11:34:19 +02:00
project [IMP] discuss: documentation updated (#655) 2020-06-04 08:45:29 +02:00
purchase [FIX] purchase/purchases/rfq/3_way_matching: fixed text mistake 2020-08-27 08:29:15 +02:00
quality [IMP] Inventory: New screenshots for reception in 3-steps (#634) 2020-06-11 13:46:32 +02:00
sales [IMP] amazon_connector: list supported marketplaces 2020-09-18 16:43:55 +02:00
sign [ADD] sign: document the validity of e-signatures 2020-12-22 11:55:32 +01:00
sms_marketing [IMP] sms marketing: update princing_and_faq.rst (#828) 2021-01-12 09:22:14 +01:00
social_marketing [IMP] social marketing: fix typo + remove future tense in campaigns.rst 2020-08-17 12:27:19 +02:00
studio [IMP] studio: toctree (#719) 2020-07-09 09:21:04 +02:00
subscriptions [ADD] subscriptions: add automatic alerts doc 2020-08-26 17:12:43 +02:00
support [MERGE] Forward-port of branch 12.0 to 13.0 2020-12-22 11:38:53 +01:00
survey [FIX] surveys: fix typo on time_random.rst (#726) 2020-07-24 10:54:47 +02:00
timesheets [IMP] timesheets: get_started.rst (#780) 2020-11-03 12:07:39 +01:00
website [MERGE] Forward port 12.0 to 13.0 2020-06-25 08:55:05 +02:00
.gitignore [FIX] a pair of leftover warnings 2018-08-31 14:41:25 +02:00
accounting.rst [IMP] documentation: reorder the main apps' list 2020-05-12 15:02:51 +02:00
applications.rst [ADD] sign: document the validity of e-signatures 2020-12-22 11:55:32 +01:00
commit_template.txt [IMP] base: add a commit message template with the guidelines 2020-01-16 14:17:37 +01:00
conf.py [REV] conf: revert f93fb12e6b 2020-10-27 14:22:14 +01:00
contributing.rst [ADD] contributing: add doc for contributing to the documentation 2020-02-20 10:52:42 +01:00
crm.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
discuss.rst [IMP] discuss: documentation updated (#655) 2020-06-04 08:45:29 +02:00
ecommerce.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
email_marketing.rst [ADD] Email_marketing: new doc 2020-02-21 15:15:40 +01:00
events.rst [ADD] events: add documentation (#702) 2020-07-22 17:01:09 +02:00
fsm.rst [IMP] FSM: global improvement 2020-02-21 12:00:10 +01:00
general.rst [MOV] general: moving VoIP docs from "CRM" to "general" 2020-11-17 13:33:36 +01:00
helpdesk.rst [IMP] helpdesk: improvement of toctree 2020-04-09 14:37:49 +02:00
index.rst [REM] index: remove references to mementos 2020-02-06 17:02:55 +01:00
inventory.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
iot.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
legal.rst [FIX] legal: adapt icon location for old layout 2020-06-09 03:31:26 +02:00
live_chat.rst [IMP] live_chat: overhaul documentation update (#601) 2020-03-27 15:44:57 +01:00
Makefile [FIX] *: typos, wording 2019-09-16 15:49:04 +02:00
manufacturing.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
marketing_automation.rst [ADD]Marketing automation: new docs 2020-02-20 18:22:02 +01:00
planning.rst [IMP] planning: improvement toctree 2020-04-09 15:07:29 +02:00
point_of_sale.rst [IMP] PoS: improvements of the PoS doc "getting started" (#600) 2020-05-13 13:43:13 +02:00
practical.rst [ADD] practical: new doc about database upgrade 2020-12-21 14:45:15 +01:00
project.rst [IMP] project: documentation overhaul (#581) 2020-04-14 22:29:08 +02:00
purchase.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
quality.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
README.rst [MERGE] Forward-port of branch 12.0 to 13.0 2020-02-20 16:55:36 +01:00
redirects.txt [ADD] general: new documentation about Axivox as VoIP provider 2020-11-17 13:33:36 +01:00
requirements.txt [IMP] technical: allow building with Python 3 and Sphinx 2.4.0 2020-02-20 11:01:03 +01:00
sales.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
sign.rst [ADD] sign: document the validity of e-signatures 2020-12-22 11:55:32 +01:00
sms_marketing.rst [IMP]SMS Marketing: general improvements 2020-02-21 11:06:36 +01:00
social_marketing.rst [ADD] social_marketing: improved and added documentation (#578) 2020-03-16 15:27:57 +01:00
studio.rst [IMP] studio: toctree (#719) 2020-07-09 09:21:04 +02:00
subscriptions.rst [ADD] subscriptions: add automatic alerts doc 2020-08-26 17:12:43 +02:00
support.rst [MERGE] Forward-port of branch 12.0 to 13.0 2020-02-20 11:27:56 +01:00
survey.rst [ADD] survey: documentation (#563) 2020-03-27 13:28:43 +01:00
timesheets.rst [ADD] timesheets: documentation (#568) 2020-04-28 18:23:34 +02:00
website.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00

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

Build the documentation
=======================

Requirements
------------

- `Git <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#install-git>`_

- | `Python 3 <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#python>`_
  | If you don't know which subversion to choose, pick the last one.
  | Python dependencies are listed in the file ``requirements.txt`` located in the root
    directory.

  - Sphinx 2.4.0 or above.
  - Werkzeug 0.14.1

- `Make <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#make>`_

Instructions
------------

In a terminal, navigate to the root directory and execute the following command:

.. code-block:: console

   $ make html

This compiles the documentation to HTML.

Open ``documentation-user/_build/html/index.html`` in your web browser to display the render.

See `this guide
<https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#prepare-your-version>`_
for more detailed instructions.

Contribute to the documentation
===============================

For contributions to the content of the documentation, please refer to the `Introduction Guide
<https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html>`_.

To **report a content issue**, **request new content** or **ask a question**, use the `repository's
issue tracker <https://github.com/odoo/documentation-user/issues>`_ as usual.

Learn More
==========

To learn more about Odoo, in addition to the documentation, have a look at `the official eLearning
<https://odoo.com/slides>`_ and `Scale-up, The Business Game
<https://www.odoo.com/page/scale-up-business-game>`_