80c7b27827
The `redirects.txt` file used to specify redirect rules for renamed or moved documentation pages is starting to grow too big to be easily maintainable. The main reason is that the number of redirect rules that were thought to be required has been largely underestimated when implementing the 'redirects' extension. At first, we believed that no guidelines or structure were necessary because only a small amount of redirect rules would be specified. This proved wrong and the file is now becoming a mess, making it increasingly difficult to figure out where, why, when, and if a redirect rule is specified in the file. As the file is versioned, another issue emerges: conflicts occur every time a commit is forward-ported to a later version if that commit adds a redirect rule at the end of the file or at a line that was changed in the later version. As redirect rules are frequently added, and since blocks of redirect rules for new versions are added at the end of the file, this tends to happen a lot. This commit attempts to hit two birds with one stone by splitting the `redirects.txt` file into multiple files, one per version. While doing so, the existing redirect rules are ordered alphabetically and moved into contextual blocks. Instructions and guidelines on how to create redirect rules are also listed in the `redirects/MANUAL.md` file. By sorting the redirect rules and adding them in different files, the number of conflicts should decrease by a lot. task-2891912 closes odoo/documentation#2265 Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com> |
||
|---|---|---|
| .tx | ||
| content | ||
| extensions | ||
| locale | ||
| redirects | ||
| static | ||
| .gitattributes | ||
| .gitignore | ||
| commit_template.txt | ||
| conf.py | ||
| Makefile | ||
| README.md | ||
| 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.