Skip to content

Commit

Permalink
add docs test on travis
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Apr 22, 2019
1 parent b4a5085 commit 73164b2
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 9 deletions.
9 changes: 6 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ matrix:
include:
- python: 3.6
env: TEST_TYPE="flake8"
# - env: TEST_TYPE="rtd"
- env: TEST_TYPE="rtd"
- python: 2.7
env: TEST_TYPE="pytest"
- python: 3.4
Expand All @@ -13,8 +13,6 @@ matrix:
env: TEST_TYPE="pytest"
- python: 3.6
env: TEST_TYPE="pytest" PYPI_DEPLOY=true
- python: 3.7
env: TEST_TYPE="pytest"
allow_failures:
- python: 3.4
env: TEST_TYPE="pytest"
Expand All @@ -37,10 +35,15 @@ install:
if [[ "$TEST_TYPE" == "flake8" ]]; then
pip install "flake8(>=3.7,<3.8)"
fi
- |
if [[ "$TEST_TYPE" == "rtd" ]]; then
pip install sphinx
fi
script:
- if [[ "$TEST_TYPE" == "pytest" ]]; then pytest -v --cov=jsonextended --cov-report= jsonextended ; fi
- if [[ "$TEST_TYPE" == "flake8" ]]; then flake8 . ; fi
- if [[ "$TEST_TYPE" == "rtd" ]]; then cd docs; make ; fi

after_success:
- if [[ "$TEST_TYPE" == "pytest" ]]; then coveralls ; fi
Expand Down
10 changes: 5 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
.. jsonextended documentation master file, created by
sphinx-quickstart on Sat Jun 3 02:06:22 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
JSON Extended
========================================

|Build Status| |Coverage Status| |PyPI|
|Build Status| |Coverage Status| |PyPI| |Conda|

A module to extend the python json package functionality:

Expand All @@ -30,8 +28,8 @@ A module to extend the python json package functionality:
package)

- **Units schema** concept to apply and convert physical quantities (using the
pint package)
pint package)

- All functions are thoroughly documented with tested examples.

.. toctree::
Expand All @@ -56,3 +54,5 @@ Indices and tables
:target: https://coveralls.io/github/chrisjsewell/jsonextended?branch=master
.. |PyPI| image:: https://img.shields.io/pypi/v/jsonextended.svg
:target: https://pypi.python.org/pypi/jsonextended/
.. |Conda| image:: https://anaconda.org/conda-forge/jsonextended/badges/version.svg
:target: https://anaconda.org/conda-forge/jsonextended
10 changes: 9 additions & 1 deletion docs/source/readme.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
Installation
------------

From Conda (recommended):

::

conda install -c conda-forge jsonextended

From PyPi:

::

pip install jsonextended

jsonextended has no import dependancies, on Python 3.x and only
``pathlib2`` on 2.7 but, for full functionallity, it is advised to
``pathlib2`` on 2.7 but, for full functionality, it is advised to
install the following packages:

::
Expand Down

0 comments on commit 73164b2

Please sign in to comment.