openstack/openstack-manuals
Code Issues Proposed changes

Fixes formatting in README.rst

Browse Source 
- 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
This commit is contained in:
Emma Foley 2017-07-17 15:27:00 +00:00
parent 9a5b897d31
commit eaba852e0d
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.rst
View File

@ -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
<https://www.latex-project.org/get/>`_ for instructions.
<https://www.latex-project.org/get/>`_ 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.