diff --git a/README.md b/README.md new file mode 100644 index 000000000..3acd8f3eb --- /dev/null +++ b/README.md @@ -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. \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index 76a9acb00..000000000 --- a/README.rst +++ /dev/null @@ -1,47 +0,0 @@ -=========================== -End-user Odoo documentation -=========================== - -Build the documentation -======================= - -Requirements ------------- - -- `Git `_ - -- | `Python 3 `_ - | 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 `_ - -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 -`_ -for more detailed instructions. - -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. \ No newline at end of file