abc6d99af7
The previous guidelines for titles and headings included an exception to capitalize feature names as they are written in the apps. However, this exception seems to have confused most writers as it isn't always clear what should be considered as a feature name or what should be considered as a noun or noun group. This commit removes this exception to make the writing and reviewing processes easier while retaining good titles and improving consistency across the documentation. It also changes the titles of the Accounting section to provide a better example to other writers. task-id 2843109 closes odoo/documentation#1910 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|---|---|---|
| .tx | ||
| content | ||
| extensions | ||
| locale | ||
| static | ||
| .gitattributes | ||
| .gitignore | ||
| commit_template.txt | ||
| conf.py | ||
| Makefile | ||
| README.md | ||
| redirects.txt | ||
| requirements.txt | ||
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 in 13.0 (Optional)
Instructions
-
In a terminal, navigate to the root directory and compile the documentation to HTML with the following command:
makeAdditional commands are available with
make help. -
Open the file
documentation/_build/html/index.htmlin your web browser to display the render. -
See this guide for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python
functions, place your local copy of the odoo/odoo repository in the root directory. Alternatively,
create a symbolic link with odoo as link name. If the Odoo sources are not found, a warning will
be shown.
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 as usual.
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.