From 4d51aecd95a20f57a3525acb58ee504d42a100e8 Mon Sep 17 00:00:00 2001 From: "Antoine Vandevenne (anv)" Date: Wed, 28 Dec 2022 17:17:14 +0000 Subject: [PATCH] [IMP] README: remove version from links and rephrase explanations task-2897123 closes odoo/documentation#3265 Signed-off-by: Antoine Vandevenne (anv) --- README.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 2ba5e9dd8..5bead0dba 100644 --- a/README.md +++ b/README.md @@ -4,40 +4,30 @@ ### Requirements -- [Git](https://www.odoo.com/documentation/master/contributing/documentation.html#install-git) -- [Python 3.7 or 3.8](https://www.odoo.com/documentation/master/contributing/documentation.html#python) -- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/master/requirements.txt). -- [Make](https://www.odoo.com/documentation/master/contributing/documentation.html#make) -- A local copy of the [odoo/odoo repository in master](https://github.com/odoo/odoo/tree/master) (Optional) +- 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](https://github.com/odoo/odoo) (optional) ### Instructions -1. In a terminal, navigate to the root directory and compile the documentation to HTML with the - following command: - - ```sh - make - ``` - +1. In a terminal, navigate to the root directory of the documentation and build it `make`. Additional commands are available with `make help`. - -2. Open the file `documentation/_build/html/index.html` in your web browser to display the render. - -3. See [this guide](https://www.odoo.com/documentation/master/contributing/documentation.html#preview-your-changes) +2. Open the file `documentation/_build/html/index.html` in your web browser. +3. See [this guide](https://www.odoo.com/documentation/latest/contributing/documentation.html) 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. +Optional: place your local copy of the `odoo/odoo` repository 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](https://www.odoo.com/documentation/master/contributing/documentation.html). +[Introduction Guide](https://www.odoo.com/documentation/latest/contributing/documentation.html). To **report a content issue**, **request new content** or **ask a question**, use the -[repository's issue tracker](https://github.com/odoo/documentation-user/issues) as usual. +[repository's issue tracker](https://github.com/odoo/documentation/issues). ## Learn More