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

[FIX] README: replace non-processed directives by absolute links

Browse Source
This commit is contained in:
Antoine Vandevenne (anv) 2020-02-20 16:33:26 +01:00
parent ce6785d158
commit 8aae0e448e
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.rst
View File

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