diff options
author | 2017-03-30 10:14:04 +0800 | |
---|---|---|
committer | 2017-03-30 22:00:03 +0800 | |
commit | f6b8615a4e69a908f4637a23d98214c960347701 (patch) | |
tree | d82d650d4a07dc9e44c8c682f9ebd8b47d2f674b /docs/testing/developer/devguide/overview.rst | |
parent | 14e9c620366b46481aef204edcf892bbaa4ef6be (diff) |
Normalize all section headers
- folder with `index.rst` for parts, using # with overline for heading
- `*.rst` file for chapter, using * with overline for heading
In each *.rst file, use the following token for heading
- =, for sections
- -, for subsections
- ^, for subsubsections
- ", for paragraphs
Change-Id: I6c247c1f1e27e891d0dade099195ef521f7dbb72
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/testing/developer/devguide/overview.rst')
-rw-r--r-- | docs/testing/developer/devguide/overview.rst | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst index d394574e..1d7e22fe 100644 --- a/docs/testing/developer/devguide/overview.rst +++ b/docs/testing/developer/devguide/overview.rst @@ -3,9 +3,9 @@ .. (c) 2017 ZTE Corporation -######## +******** Overview -######## +******** QTIP uses Python as primary programming language and build the framework from the following packages @@ -19,16 +19,15 @@ docs `sphinx`_ - a tool that makes it easy to create intelligent and beautif testing `pytest`_ - a mature full-featured Python testing tool that helps you write better programs ======== =============================================================================================================== -*********** + Source Code -*********** +=========== - The structure of repository is based on the recommended sample in -`The Hitchhiker's Guide to Python`_ +The structure of repository is based on the recommended sample in `The Hitchhiker's Guide to Python`_ -================== ======================================================================================================== +================== ==================================================================================================== Path Content -================== ======================================================================================================== +================== ==================================================================================================== ``./benchmarks/`` builtin benchmark assets including plan, QPI and metrics ``./contrib/`` independent project/plugin/code contributed to QTIP ``./docker/`` configuration for building Docker image for QTIP deployment @@ -38,11 +37,11 @@ Path Content ``./qtip/`` the actual package ``./tests/`` package functional and unit tests ``./third-party/`` third part included in QTIP project -================== ======================================================================================================== +================== ==================================================================================================== + -************ Coding Style -************ +============ QTIP follows `OpenStack Style Guidelines`_ for source code and commit message. @@ -52,19 +51,19 @@ Specially, it is recommended to link each patch set with a JIRA issue. Put:: in commit message to create an automatic link. -******* + Testing -******* +======= All testing related code are stored in ``./tests/`` -================== ======================================================================================================== +================== ==================================================================================================== Path Content -================== ======================================================================================================== +================== ==================================================================================================== ``./tests/data/`` data fixtures for testing ``./tests/unit/`` unit test for each module, follow the same layout as ./qtip/ ``./conftest.py`` pytest configuration in project scope -================== ======================================================================================================== +================== ==================================================================================================== `tox`_ is used to automate the testing tasks |