NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[IMP] README: remove version from links and rephrase explanations

Browse Source 
task-2897123

closes odoo/documentation#3249

Signed-off-by: Antoine Vandevenne (anv) <anv@odoo.com>
This commit is contained in:
Antoine Vandevenne (anv) 2022-12-28 17:17:14 +00:00
parent 2e96c049fe
commit c919778f0a
1 changed files with 12 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -4,40 +4,30 @@
### Requirements ### Requirements
- [Git](https://www.odoo.com/documentation/15.0/contributing/documentation.html#install-git) - Git
- [Python 3.7 or 3.8](https://www.odoo.com/documentation/15.0/contributing/documentation.html#python) - Python 3.6, 3.7, or 3.8
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/15.0/requirements.txt). - Python dependencies listed in the file `requirements.txt`.
- [Make](https://www.odoo.com/documentation/15.0/contributing/documentation.html#make) - Make
- A local copy of the [odoo/odoo repository in 15.0](https://github.com/odoo/odoo/tree/15.0) (Optional) - A local copy of the [odoo/odoo repository](https://github.com/odoo/odoo) (optional)
### Instructions ### Instructions
1. In a terminal, navigate to the root directory and compile the documentation to HTML with the 1. In a terminal, navigate to the root directory of the documentation and build it `make`.
following command:
```sh
make
```
Additional commands are available with `make help`. Additional commands are available with `make help`.
2. Open the file `documentation/_build/html/index.html` in your web browser.
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/latest/contributing/documentation.html)
3. See [this guide](https://www.odoo.com/documentation/15.0/contributing/documentation.html#preview-your-changes)
for more detailed instructions. for more detailed instructions.
Optional: to fully build the developer documentation with inline docstrings for documented Python Optional: place your local copy of the `odoo/odoo` repository in the parent directory or in the root
functions, place your local copy of the `odoo/odoo` repository in the root directory. Alternatively, directory of the documentation to build the latter with the documented Python docstrings.
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 ## Contribute to the documentation
For contributions to the content of the documentation, please refer to the For contributions to the content of the documentation, please refer to the
[Introduction Guide](https://www.odoo.com/documentation/15.0/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 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 ## Learn More