diff --git a/README.rst b/README.rst index f29fd65c0..76a9acb00 100644 --- a/README.rst +++ b/README.rst @@ -8,17 +8,17 @@ Build the documentation Requirements ------------ -- :ref:`Git ` +- `Git `_ -- | :ref:`Python 3 ` +- | `Python 3 `_ | 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. - Sphinx 2.4.0 or above. - Werkzeug 0.14.1 -- :ref:`Make ` +- `Make `_ Instructions ------------ @@ -31,15 +31,17 @@ In a terminal, navigate to the root directory and execute the following command: 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 +`_ +for more detailed instructions. Contribute to the documentation =============================== -For contributions to the content of the documentation, please refer to -:doc:`contributing/documentation/introduction_guide`. +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