From eaba852e0d43127bc0648a39bc1650020bb1a262 Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Mon, 17 Jul 2017 15:27:00 +0000 Subject: [PATCH] Fixes formatting in README.rst - Fixes inconsistent formatting on tox command examples - Fixes broken link for "Getting Latex" - Fixes bulleted list formatted as a code block - Fixes literal rendering of ":command:`tox`" Change-Id: Ie2cc4f890c41da86c613d4bbce34a66017c81c85 Closes-Bug: #1704813 --- README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 8f3519f819..fc214e21f8 100644 --- a/README.rst +++ b/README.rst @@ -48,7 +48,7 @@ the ``bindep`` command:: $ tox -e bindep All guides are in the RST format. You can use ``tox`` to prepare -virtual environment and build all guides (HTML only): +virtual environment and build all guides (HTML only):: $ tox -e docs @@ -71,7 +71,7 @@ generated HTML documentation. If you get this message `make: xelatex: No such file or directory` it means your local environment does not have LaTeX installed. Read `Getting LaTeX - `_ for instructions. +`_ for instructions. Testing of changes and building of the manual ============================================= @@ -82,12 +82,12 @@ CI jobs. If you like to run individual tests, run: - * ``tox -e checkbuild`` - to actually build the manual - * ``tox -e checklang`` - to build translated manuals - * ``tox -e checkniceness`` - to run the niceness tests - * ``tox -e linkcheck`` - to run the tests for working remote URLs +* ``tox -e checkbuild`` - to actually build the manual +* ``tox -e checklang`` - to build translated manuals +* ``tox -e checkniceness`` - to run the niceness tests +* ``tox -e linkcheck`` - to run the tests for working remote URLs -The :command:`tox` command uses the openstack-doc-tools package to run the +The ``tox`` command uses the openstack-doc-tools package to run the tests.