rearrange existing documentation to follow the new standard layout
Change-Id: I97e3c740a1e96d45838fca9227712c602fec59b6 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
This commit is contained in:
parent
20f1fb6f10
commit
be5c088604
@ -1,4 +1,4 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
.. include:: ../../../CONTRIBUTING.rst
|
@ -1,22 +1,27 @@
|
||||
.. coverage2sql documentation master file, created by
|
||||
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
========================================================
|
||||
Welcome to coverage2sql's documentation!
|
||||
========================================================
|
||||
|
||||
Contents
|
||||
========
|
||||
.. image:: http://governance.openstack.org/badges/coverage2sql.svg
|
||||
:target: http://governance.openstack.org/reference/tags/index.html
|
||||
|
||||
Command to Read a coverage file and put the data in a SQL database
|
||||
|
||||
coverage2sql is a tool for storing data of test coverage into a SQL database.
|
||||
With using this tool, you can store time series coverage data and analyze it
|
||||
if your coverage rate is down.
|
||||
|
||||
* Free software: Apache license
|
||||
* Documentation: http://docs.openstack.org/developer/coverage2sql
|
||||
* Source: http://git.openstack.org/cgit/openstack/coverage2sql
|
||||
* Bugs: http://bugs.launchpad.net/coverage2sql
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
installation
|
||||
usage
|
||||
contributing
|
||||
install/index
|
||||
user/index
|
||||
contributor/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
@ -1,7 +0,0 @@
|
||||
========
|
||||
Usage
|
||||
========
|
||||
|
||||
To use coverage2sql in a project::
|
||||
|
||||
import coverage2sql
|
58
doc/source/user/index.rst
Normal file
58
doc/source/user/index.rst
Normal file
@ -0,0 +1,58 @@
|
||||
=====
|
||||
Usage
|
||||
=====
|
||||
|
||||
DB Setup
|
||||
--------
|
||||
|
||||
The usage of coverage2sql is split into 2 stages. First you need to prepare a
|
||||
database with the proper schema; coverage2sql-db-manage should be used to do
|
||||
this. The utility requires db connection info which can be specified with a
|
||||
config file. Obviously the sql connector type, user,
|
||||
password, address, and database name should be specific to your environment.
|
||||
coverage2sql-db-manage will use alembic to setup the db schema. You can run the
|
||||
db migrations with a config file::
|
||||
|
||||
coverage2sql-db-manage --config-file etc/coverage2sql.conf upgrade head
|
||||
|
||||
This will bring the DB schema up to the latest version for coverage2sql.
|
||||
|
||||
.. _coverage2sql:
|
||||
|
||||
coverage2sql
|
||||
------------
|
||||
|
||||
Once you have a database setup with the proper database schema you can then use
|
||||
the coverage2sql command to populate the database with data from your test
|
||||
coverage file. coverage2sql takes in a `.coverage file`_ through by passing it
|
||||
file paths as positional arguments to the script at this moment.
|
||||
|
||||
.. _.coverage file: http://coverage.readthedocs.io/en/latest/cmd.html#data-file
|
||||
|
||||
There are several options for running coverage2sql, they can be listed with::
|
||||
|
||||
coverage2sql --help
|
||||
|
||||
The only required option is --database-connection. The options can either be
|
||||
used on the CLI, or put in a config file. If a config file is used you need to
|
||||
specify the location on the CLI.
|
||||
|
||||
Using in project
|
||||
----------------
|
||||
|
||||
To use coverage2sql in a project::
|
||||
|
||||
import coverage2sql
|
||||
|
||||
TODO
|
||||
----
|
||||
|
||||
To see the TODO, go to the launchpad site:
|
||||
|
||||
* `https://bugs.launchpad.net/coverage2sql <https://bugs.launchpad.net/coverage2sql>`_
|
||||
* `https://blueprints.launchpad.net/coverage2sql <https://blueprints.launchpad.net/coverage2sql>`_
|
||||
|
||||
ChangeLog
|
||||
---------
|
||||
|
||||
To see the release notes go here: `http://docs.openstack.org/releasenotes/coverage2sql/ <http://docs.openstack.org/releasenotes/coverage2sql/>`_
|
Loading…
Reference in New Issue
Block a user