Odoo documentation sources
Go to file
2020-09-25 15:27:45 +02:00
_extensions https links ? 2020-09-25 15:27:45 +02:00
_static [MERGE] One _static folder 2020-09-25 12:55:58 +02: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 2020-09-22 17:14:17 +02:00
contributing [ADD] contribution: new doc about content guidelines (#668) 2020-05-18 20:35:13 +02:00
developer sphinx errors fixes 2020-09-25 14:56:39 +02:00
user sphinx errors fixes 2020-09-25 14:56:39 +02:00
.gitignore [FIX] a pair of leftover warnings 2018-08-31 14:41:25 +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 sphinx errors fixes 2020-09-25 14:56:39 +02:00
contributing.rst [ADD] contributing: add doc for contributing to the documentation 2020-02-20 10:52:42 +01:00
index.rst [MOV] user doc to its own folder 2020-09-25 12:58:31 +02:00
Makefile [MOV] odoo -> odoo_ext extensions to avoid naming conflicts 2020-09-24 17:45:03 +02: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 13.3 2020-07-29 09:54:59 +02:00
requirements.txt [IMP] technical: allow building with Python 3 and Sphinx 2.4.0 2020-02-20 11:01:03 +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>`_