diff --git a/README b/README.rst similarity index 86% rename from README rename to README.rst index 0eacdf2b..94185839 100644 --- a/README +++ b/README.rst @@ -1,3 +1,7 @@ +OpenStack Operations Guide ++++++++++++++++++++ + + This repository contains the source files for the OpenStack Operations Guide. You can read this guide at `docs.openstack.org/ops `_. @@ -43,10 +47,11 @@ directory to use the same tests that are done as part of our Jenkins gating jobs. If you like to run individual tests, run: -* "tox -e checkniceness" - to run the niceness tests -* "tox -e checksyntax" - to run syntax checks -* "tox -e checkdeletions" - to check that no deleted files are referenced -* "tox -e checkbuild" - to actually build the manual + + * ``tox -e checkniceness`` - to run the niceness tests + * ``tox -e checksyntax`` - to run syntax checks + * ``tox -e checkdeletions`` - to check that no deleted files are referenced + * ``tox -e checkbuild`` - to actually build the manual tox will use the openstack-doc-tools package for execution of these tests.