Odoo documentation sources
Go to file
KC (ksc) 636bdc5bd1 [REM] ecommerce: doc about product availability
Remove unnecessary, straightforward, easy-to-figure out documentation, as part of an effort to clear
out any sort of documentation that is either too easy, too simple,
or already gone over in the tutorial videos. This documentation falls into that category. Hence,
it was removed entirely.
2021-04-12 17:06:35 +02:00
_extensions [FIX] *: update v14 urls 2020-11-27 08:03:45 +01:00
_static [MERGE] Forward-port of branch 13.0 to 14.0 2021-03-24 11:38:17 +01:00
.github [ADD] .github: introduce code-owners file for reviewers 2020-04-16 11:31:20 +02:00
.tx [I18N] *: export 14.0 source terms 2021-02-04 11:30:29 +01:00
accounting [MERGE] Forward-port of branch 13.0 to 14.0 2021-04-01 10:54:18 +02:00
contributing [MERGE] Forward-port of branch 13.0 to 14.0 2021-04-01 10:54:18 +02:00
crm [MERGE] Forward-port of branch 13.0 to 14.0 2020-12-22 12:17:47 +01:00
db_management [MERGE] Forward-port of branch 12.O to 13.0 2021-01-27 10:10:12 +01:00
discuss [MERGE] Forward-port of branch 13.0 to 14.0 2021-03-24 11:38:17 +01:00
ecommerce [REM] ecommerce: doc about product availability 2021-04-12 17:06:35 +02:00
expense [IMP] accounting: add new version of doc about taxes (#703) 2020-06-25 12:32:02 +02:00
fsm [FIX] Field Service: fix a typo on the helpdesk tickets page (#797) 2020-11-26 09:57:24 +01:00
general [MERGE] Forward-port of branch 13.0 to 14.0 2021-04-01 10:54:18 +02:00
getting_started [FIX] *: fix incorrect/unstable links 2020-01-15 10:52:05 +01:00
helpdesk [REM] manufacturing: straightforward docs removed (#871) 2021-03-05 13:01:06 +01:00
inventory [IMP] inventory: update doc "Resupply from another Warehouse" (#906) 2021-03-24 07:52:20 -07:00
iot [FIX] iot: Update and fix IoT documentation (#776) 2020-10-22 14:32:59 +02:00
legal [IMP] legal/terms: update partnership contract to v9b 2021-01-12 17:47:36 +01: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-04-11 01:30:34 +02:00
manufacturing [REM] manufacturing: straightforward docs removed (#871) 2021-03-05 13:01:06 +01:00
marketing_automation [REM] marketing automation: remove docs (#878) 2021-03-12 08:48:55 +01:00
mobile [IMP] *: update banners 2020-02-06 17:15:02 +01:00
odoo_sh [MERGE] Forward-port of branch 13.0 to 14.0 2021-03-24 11:38:17 +01:00
point_of_sale [REM] pos/accounting: remove a note and fix rst in cash rounding 2021-02-23 08:39:40 +01:00
portal [MERGE] Forward-port of branch 12.0 to 13.0 2021-03-02 16:33:39 +01:00
project [REM] project: remove doc (#879) 2021-03-12 08:49:05 +01:00
purchase [MERGE] Forward-port of branch 12.0 to 13.0 2021-03-24 11:28:34 +01:00
sales [MERGE] Forward-port of branch 13.0 to 14.0 2021-04-01 10:54:18 +02:00
sign [ADD] sign: document the validity of e-signatures 2020-12-22 11:55:32 +01:00
sms_marketing [REM] sms marketing: remove docs (#875) 2021-03-12 08:48:43 +01:00
studio [REM] project: collaborate.rst (#779) 2020-10-30 09:20:27 +01: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 [REM] timesheets: remove compare.rst & get_started.rst (#794) 2020-11-24 09:24:47 +01:00
website [MERGE] Forward-port of branch 13.0 to 14.0 2021-04-01 10:54:18 +02:00
.gitignore [FIX] a pair of leftover warnings 2018-08-31 14:41:25 +02:00
accounting.rst [IMP] accounting: change the section name "fiscality" into "taxation" (#920) 2021-03-26 22:50:01 +01:00
applications.rst [REM] planning: remove docs (#880) 2021-03-12 08:49:27 +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 [FIX] conf: rename the new version 2020-10-06 13:44:42 +02: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
fsm.rst [REM] Field Service: remove six pages (#795) 2020-11-24 12:36:59 +01:00
general.rst [MERGE] Forward-port of branch 13.0 to 14.0 2020-12-22 12:17:47 +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 [REM] inventory: remove overview.rst (#865) 2021-03-02 15:52:59 +01:00
iot.rst [IMP] *: update banners 2020-02-06 17:15:02 +01:00
legal.rst [IMP] accounting/loc: add GoBD section to loc/germany 2021-02-03 19:56:34 +01: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 [REM] manufacturing: straightforward docs removed (#871) 2021-03-05 13:01:06 +01:00
marketing_automation.rst [REM] marketing automation: remove docs (#878) 2021-03-12 08:48:55 +01: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 [REM] project: remove doc (#879) 2021-03-12 08:49:05 +01:00
purchase.rst [IMP] purchase: merge and update blanket orders and calls for tenders 2021-02-05 10:34:31 +01:00
README.rst [MERGE] Forward-port of branch 12.0 to 13.0 2020-02-20 16:55:36 +01:00
redirects.txt [MERGE] Forward-port of branch 13.0 to 14.0 2021-04-01 10:54:18 +02: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 [REM] sms marketing: remove docs (#875) 2021-03-12 08:48:43 +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>`_