Skip to content

Commit

Permalink
Merge pull request #26 from standage/docs/update
Browse files Browse the repository at this point in the history
Cleaning up docs
  • Loading branch information
standage committed Dec 14, 2016
2 parents dd8fd80 + 99fcfb9 commit 2eb3737
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 14 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ script:
- make style
after_success:
- make loc
- bash <(curl -s https://codecov.io/bash)
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
# tag: Toolkit for Annotating Genomes

## Package status

I'm currently building the core of the package. The API is in flux and there are
no command-line tools or scripts yet. Once the core is more mature, building
scripts or using **tag** interactively should be fairly trivial (that's the
intent/design, at least).

So far, **tag** has been able to maintain compatibility with both Python 2
and 3. Also, coverage from unit testing is at 100%!
![Supported Python versions](https://img.shields.io/pypi/pyversions/tag.svg)
[![PyPI version](https://img.shields.io/pypi/v/tag.svg)](https://pypi.python.org/pypi/tag)
[![GenHub build status](https://img.shields.io/travis/standage/tag.svg)](https://travis-ci.org/standage/tag)
[![codecov.io coverage](https://img.shields.io/codecov/c/github/standage/tag.svg)](https://codecov.io/github/standage/tag)
[![BSD-3 licensed](https://img.shields.io/pypi/l/tag.svg)](https://github.com/standage/tag/blob/master/LICENSE)
8 changes: 4 additions & 4 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
The :code:`tag` Python API
==========================
The Python API
==============

The following classes/modules are included in the :code:`tag` Python API, which
is under `semantic versioning <http://semver.org>`_.
The following classes/modules are included tag's Python API, which is under
`semantic versioning <http://semver.org>`_.

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
html_theme = 'nature'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down

0 comments on commit 2eb3737

Please sign in to comment.