openstack
/
tempest
Code Issues Proposed changes

Fix 'ref' format errors in README file 

While releasing new version in pypi, it perform the
validation on the package and give error if there is any
formatting issue.

README file is being used to upload on pypi and so validation
check fails[1] on current README due to 'ref' used for internal
doc link. Those links would not be available for outside the built doc.
This can be checked locally by:
    python setup.py check -s -r

This commit fixes those format issue by removing the ref and provide the
external links.

Needed-By: https://review.openstack.org/#/c/592276/

[1] http://logs.openstack.org/76/592276/2/check/openstack-tox-validate/3623847/job-output.txt.gz#_2018-08-16_07_04_37_877872

Change-Id: I3e8bf5df2b1292725863065b7f3a9f9cca9adb75
This commit is contained in:
ghanshyam 2018-08-16 07:49:54 +00:00 committed by Ghanshyam Mann
parent f87c08c7c9
commit 3662499105
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -95,10 +95,12 @@ as it is simpler, and quicker to work with.
command. Tempest is expecting a ``tempest.conf`` file in etc/ so if only a
sample exists you must rename or copy it to tempest.conf before making
any changes to it otherwise Tempest will not know how to load it. For
details on configuring Tempest refer to the :ref:`tempest-configuration`.
details on configuring Tempest refer to the
`Tempest Configuration <https://docs.openstack.org/tempest/latest/configuration.html#tempest-configuration>`_
#. Once the configuration is done you're now ready to run Tempest. This can
be done using the :ref:`tempest_run` command. This can be done by either
be done using the `Tempest Run <https://docs.openstack.org/tempest/latest/run.html#tempest-run>`_
command. This can be done by either
running::
$ tempest run
@ -129,7 +131,8 @@ Tempest library interface, other pieces of Tempest do not have the same
stable interface and there are no guarantees on the Python API unless otherwise
stated.
For more details refer to the library documentation here: :ref:`library`
For more details refer to the library documentation here: `Library
<https://docs.openstack.org/tempest/latest/library.html#library>`_
Release Versioning
------------------
@ -165,8 +168,10 @@ Configuration
-------------
Detailed configuration of Tempest is beyond the scope of this
document see :ref:`tempest-configuration` for more details on configuring
Tempest. The ``etc/tempest.conf.sample`` attempts to be a self-documenting
document, see `Tempest Configuration Documentation
<https://docs.openstack.org/tempest/latest/configuration.html#tempest-configuration>`_
for more details on configuring Tempest.
The ``etc/tempest.conf.sample`` attempts to be a self-documenting
version of the configuration.
You can generate a new sample tempest.conf file, run the following