Odoo documentation sources
Go to file
KC (ksc) e976c19b96 [REM] ecommerce: intro to ecommerce
Removes 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-05-10 10:52:45 +02:00
.github [IMP] CODEOWNERS: add new codeowner for technical files 2021-05-05 11:09:31 +02:00
.tx [I18N] update 13.0 source terms 2020-03-19 13:05:28 +01:00
content [REM] ecommerce: intro to ecommerce 2021-05-10 10:52:45 +02:00
extensions [FIX] homepage: fix broken top links 2021-05-04 17:32:28 +02:00
locale [I18N] Update translation terms from Transifex 2021-05-02 01:30:41 +02:00
static [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00
.gitignore [REF][MOV] documentation apocalypse 2021-05-04 15:44:00 +02:00
commit_template.txt [IMP] base: add a commit message template with the guidelines 2020-01-16 14:17:37 +01:00
conf.py [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00
Makefile [MERGE] Forward-port of branch 12.0 to 13.0 2021-05-04 16:31:06 +02:00
README.rst [MERGE] Forward-port of branch 12.0 to 13.0 2020-02-20 16:55:36 +01:00
redirects.txt [FIX] redirects: update links after apocalypse reorganisation 2021-05-04 17:47:03 +02:00
requirements.txt [REF][MOV] documentation apocalypse 2021-05-04 15:44:00 +02: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>`_