Browse Source

rearrange existing documentation to follow the new standard layout

Change-Id: I97e3c740a1e96d45838fca9227712c602fec59b6
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Dong Ma 1 year ago
parent
commit
be5c088604

doc/source/contributing.rst → doc/source/contributor/index.rst View File

@@ -1,4 +1,4 @@
1 1
 ============
2 2
 Contributing
3 3
 ============
4
-.. include:: ../../CONTRIBUTING.rst
4
+.. include:: ../../../CONTRIBUTING.rst

+ 16
- 11
doc/source/index.rst View File

@@ -1,22 +1,27 @@
1
-.. coverage2sql documentation master file, created by
2
-   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
3
-   You can adapt this file completely to your liking, but it should at least
4
-   contain the root `toctree` directive.
5
-
6 1
 ========================================================
7 2
 Welcome to coverage2sql's documentation!
8 3
 ========================================================
9 4
 
10
-Contents
11
-========
5
+.. image:: http://governance.openstack.org/badges/coverage2sql.svg
6
+    :target: http://governance.openstack.org/reference/tags/index.html
7
+
8
+Command to Read a coverage file and put the data in a SQL database
9
+
10
+coverage2sql is a tool for storing data of test coverage into a SQL database.
11
+With using this tool, you can store time series coverage data and analyze it
12
+if your coverage rate is down.
13
+
14
+* Free software: Apache license
15
+* Documentation: http://docs.openstack.org/developer/coverage2sql
16
+* Source: http://git.openstack.org/cgit/openstack/coverage2sql
17
+* Bugs: http://bugs.launchpad.net/coverage2sql
12 18
 
13 19
 .. toctree::
14 20
    :maxdepth: 2
15 21
 
16
-   readme
17
-   installation
18
-   usage
19
-   contributing
22
+   install/index
23
+   user/index
24
+   contributor/index
20 25
 
21 26
 Indices and tables
22 27
 ==================

doc/source/installation.rst → doc/source/install/index.rst View File


+ 0
- 1
doc/source/readme.rst View File

@@ -1 +0,0 @@
1
-.. include:: ../../README.rst

+ 0
- 7
doc/source/usage.rst View File

@@ -1,7 +0,0 @@
1
-========
2
-Usage
3
-========
4
-
5
-To use coverage2sql in a project::
6
-
7
-    import coverage2sql

+ 58
- 0
doc/source/user/index.rst View File

@@ -0,0 +1,58 @@
1
+=====
2
+Usage
3
+=====
4
+
5
+DB Setup
6
+--------
7
+
8
+The usage of coverage2sql is split into 2 stages. First you need to prepare a
9
+database with the proper schema; coverage2sql-db-manage should be used to do
10
+this. The utility requires db connection info which can be specified with a
11
+config file. Obviously the sql connector type, user,
12
+password, address, and database name should be specific to your environment.
13
+coverage2sql-db-manage will use alembic to setup the db schema. You can run the
14
+db migrations with a config file::
15
+
16
+    coverage2sql-db-manage --config-file etc/coverage2sql.conf upgrade head
17
+
18
+This will bring the DB schema up to the latest version for coverage2sql.
19
+
20
+.. _coverage2sql:
21
+
22
+coverage2sql
23
+------------
24
+
25
+Once you have a database setup with the proper database schema you can then use
26
+the coverage2sql command to populate the database with data from your test
27
+coverage file. coverage2sql takes in a `.coverage file`_ through by passing it
28
+file paths as positional arguments to the script at this moment.
29
+
30
+.. _.coverage file: http://coverage.readthedocs.io/en/latest/cmd.html#data-file
31
+
32
+There are several options for running coverage2sql, they can be listed with::
33
+
34
+    coverage2sql --help
35
+
36
+The only required option is --database-connection. The options can either be
37
+used on the CLI, or put in a config file. If a config file is used you need to
38
+specify the location on the CLI.
39
+
40
+Using in project
41
+----------------
42
+
43
+To use coverage2sql in a project::
44
+
45
+    import coverage2sql
46
+
47
+TODO
48
+----
49
+
50
+To see the TODO, go to the launchpad site:
51
+
52
+* `https://bugs.launchpad.net/coverage2sql <https://bugs.launchpad.net/coverage2sql>`_
53
+* `https://blueprints.launchpad.net/coverage2sql <https://blueprints.launchpad.net/coverage2sql>`_
54
+
55
+ChangeLog
56
+---------
57
+
58
+To see the release notes go here: `http://docs.openstack.org/releasenotes/coverage2sql/ <http://docs.openstack.org/releasenotes/coverage2sql/>`_

Loading…
Cancel
Save