Skip to content

Commit

Permalink
Fix up docs warnings
Browse files Browse the repository at this point in the history
Make docs warnings errors

Fix up paragraph's wording
  • Loading branch information
sigmavirus24 committed Dec 22, 2015
1 parent 7cce0ea commit bdc11a3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
11 changes: 7 additions & 4 deletions docs/usage_patterns.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,10 @@ example, in github3.py, I do the following:
os.environ.get('GH_AUTH', 'x' * 20)
)
In essence, if the tests are being run on TravisCI_, then we want to make sure
to not try to record new cassettes or interactions. We also, want to make sure
we're authenticated when possible but that we do not leave our placeholder in
the cassettes when they're replayed.
In essence, if the tests are being run on `Travis CI`_, then we want to make
sure to not try to record new cassettes or interactions. We also, want to
ensure we're authenticated when possible but that we do not leave our
placeholder in the cassettes when they're replayed.

Using Human Readble JSON Cassettes
----------------------------------
Expand Down Expand Up @@ -115,3 +115,6 @@ is recommended you make a backup of your cassettes first in the event something
goes wrong.

.. [#] http://pytest.org/latest/plugins.html
.. _py.test: http://pytest.org/latest/
.. _Travis CI: https://travis-ci.org/
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ deps =
readme
.
commands =
sphinx-build -E -c docs -b html docs/ docs/_build/html
sphinx-build -W -E -c docs -b html docs/ docs/_build/html

[testenv:readme]
deps =
Expand Down

0 comments on commit bdc11a3

Please sign in to comment.