Odoo documentation sources
Go to file
Victor Feyens 080835be2b [ADD] tests: add sphinxlint checkers for headings
task-2801043

X-original-commit: ad768c33aa
Part-of: odoo/documentation#3553
Co-authored-by: Antoine Vandevenne (anv) <anv@odoo.com>
2023-02-13 14:05:35 +01:00
.tx [I18N] migrate to the nex transifex API 2023-02-10 16:49:10 +01:00
content [FIX] *: first small clean of the code 2023-02-13 14:05:23 +01:00
extensions [IMP] toctrees: redesign and new card component 2023-01-26 18:51:23 +01:00
locale [FIX] inventory_and_mrp: documentation update 2022-04-21 18:45:24 +02:00
redirects [IMP] accounting/l10n: Italian Localization 2023-02-10 10:13:14 +01:00
static [FIX] core: latex build 2022-12-15 21:18:57 +01:00
tests [ADD] tests: add sphinxlint checkers for headings 2023-02-13 14:05:35 +01:00
.gitattributes [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-29 11:01:52 +02:00
.gitignore [ADD] .gitattributes: include RST files in language statistic on GitHub 2022-04-29 11:01:52 +02:00
commit_template.txt [FIX] *: enforce 1 newline on files end 2022-11-18 18:04:49 +01:00
conf.py [IMP] conf: add names for newly activated languages 2023-02-08 12:25:57 +01:00
Makefile [ADD] tests: add sphinxlint checkers for headings 2023-02-13 14:05:35 +01:00
README.md [IMP] README: remove version from links and rephrase explanations 2023-01-03 20:14:55 +01:00
requirements.txt [IMP] conf.py, requirements.txt, *: allow building with Python 3.10 2022-07-14 16:42:08 +02:00

Odoo documentation

Build the documentation locally

Requirements

  • Git
  • Python 3.6, 3.7, or 3.8
  • Python dependencies listed in the file requirements.txt.
  • Make
  • A local copy of the odoo/odoo repository (optional)

Instructions

  1. In a terminal, navigate to the root directory of the documentation and build it make. Additional commands are available with make help.
  2. Open the file documentation/_build/html/index.html in your web browser.
  3. See this guide for more detailed instructions.

Optional: place your local copy of the odoo/odoo repository in the parent directory or in the root directory of the documentation to build the latter with the documented Python docstrings.

Contribute to the documentation

For contributions to the content of the documentation, please refer to the Introduction Guide.

To report a content issue, request new content or ask a question, use the repository's issue tracker.

Learn More

To learn more about Odoo, in addition to the documentation, have a look at the official eLearning and Scale-up, The Business Game.