mirror of
https://github.com/odoo/documentation.git
synced 2026-01-02 17:59:20 +07:00
601f915e98
There have been several new odooers who've hit legal/cla mismatches, and after
investigation their email address would be smart quoted in git (e.g.
`<“uid@example.org”>`).
That the documentation itself uses smart quotes is highly suspicious, it would
make sense that new developers just pasted the provided command, updated it to
match, and didn't even notice the quotes were wrong: `git` is perfectly happy
with it, only on reading it back can you realise it's wrong and the guide
doesn't say anything about *that*.
So fix the quotes in the doc, and hopefully that'll resolve the issue.
closes odoo/documentation#10445
X-original-commit: 811b442fcc
Signed-off-by: Xavier Morel (xmo) <xmo@odoo.com>
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)
- A local copy of the odoo/upgrade-util repository (optional)
Instructions
- In a terminal, navigate to the root directory of the documentation and build it
make. Additional commands are available withmake help. - Open the file
documentation/_build/html/index.htmlin your web browser. - See this guide for more detailed instructions.
Optional: place your local copy of the odoo/odoo and odoo/upgrade-util repositories 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.