[IMP] README: update README and translate it to Markdown

This commit is contained in:
Antoine Vandevenne (anv) 2021-05-12 18:08:38 +02:00 committed by Antoine Vandevenne (anv)
parent 26d489c6e1
commit ca6b1c602d
2 changed files with 43 additions and 47 deletions

43
README.md Normal file
View File

@ -0,0 +1,43 @@
# Odoo documentation
## Build the documentation locally
### Requirements
- [Git](https://www.odoo.com/documentation/12.0/contributing/documentation/introduction_guide.html#install-git)
- [Python 3.6, 3.7, or 3.8](https://www.odoo.com/documentation/12.0/contributing/documentation/introduction_guide.html#python)
- Python dependencies listed in the file [`requirements.txt`](https://github.com/odoo/documentation/tree/12.0/requirements.txt).
- [Make](https://www.odoo.com/documentation/12.0/contributing/documentation/introduction_guide.html#make)
- A local copy of the [odoo/odoo repository in 12.0](https://github.com/odoo/odoo/tree/12.0) (Optional)
### Instructions
1. In a terminal, navigate to the root directory and compile the documentation to HTML with the
following command:
```sh
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/12.0/contributing/documentation/introduction_guide.html#preview-your-changes)
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](https://www.odoo.com/documentation/12.0/contributing/documentation/introduction_guide.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.
If you have a pull request that is ready for review, request one from the
[odoo/doc-review](https://github.com/orgs/odoo/teams/doc-review) team.

View File

@ -1,47 +0,0 @@
===========================
End-user Odoo documentation
===========================
Build the documentation
=======================
Requirements
------------
- `Git <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#install-git>`_
- | `Python 3 <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#python>`_
| If you don't know which subversion to choose, pick the last one.
| Python dependencies are listed in the file ``requirements.txt`` located in the root
directory.
- Sphinx 2.4.0 or above.
- Werkzeug 0.14.1
- `Make <https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#make>`_
Instructions
------------
In a terminal, navigate to the root directory and execute the following command:
.. code-block:: console
$ make html
This compiles the documentation to HTML.
Open ``documentation-user/_build/html/index.html`` in your web browser to display the render.
See `this guide
<https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.html#prepare-your-version>`_
for more detailed instructions.
Contribute to the documentation
===============================
For contributions to the content of the documentation, please refer to the `Introduction Guide
<https://www.odoo.com/documentation/user/contributing/documentation/introduction_guide.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.