fd56d8c170
The previous makefile was compiling css beside the style.scss and the style.css was copied at the end. The new makefile compile css directly in the build dir. Since this file was still present in the source because of the .gitignore, sphinx was using this old version of style.css, overriding the new compiled css file at the end. Removing it from gitignore should helpFix this problem. This commit also fix some path in makefile. (not critical but this should fix a potential error in static command) closes odoo/documentation#1084 Signed-off-by: Antoine Vandevenne (anv) <AntoineVDV@users.noreply.github.com> |
||
|---|---|---|
| .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 12.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.