dc74dd679b
Reworked the Website portion of the documentation to update the screenshots (and processes) for v14 and condensed (instead of deleted) the easier, more straight-forward portions. Removed the "Ensure all URLs use custom domain" section of domain_names.rst because I could not find any section that it spoke about, nor could I find anything called "System Parameters." If there is a new process (or place to look) for such a process, please feel free to share that process (or place) with me, and I'll write it into this doc. I'll need someone with more techinical expertise to confirm that the "GeoIP" doc is correct. Same for the "Technical hints for customization" section of the Multi-Website doc, as well as the Google Analytics seciton in "Tracking" doc. |
||
|---|---|---|
| .github | ||
| .tx | ||
| content | ||
| extensions | ||
| locale | ||
| static | ||
| .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 14.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.
If you have a pull request that is ready for review, request one from the odoo/doc-review team.
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.