Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Miscellaneous doc fixes #89

Merged
merged 3 commits into from Aug 19, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 1 addition & 24 deletions README.rst
Expand Up @@ -57,30 +57,7 @@ Demo
You can run the example tests provided to see what a `marbles` failure message
looks like

.. code-block:: none

python -m marbles docs/examples/getting_started.py
F
======================================================================
FAIL: test_create_resource (docs.examples.getting_started.ResponseTestCase)
----------------------------------------------------------------------
marbles.core.marbles.ContextualAssertionError: 409 != 201

Source (/path/to/docs/examples/getting_started.py):
39 res = requests.put(endpoint, data=data)
> 40 self.assertEqual(
41 res.status_code,
42 201
43 )
Locals:
endpoint=http://example.com/api/v1/resource
data={'name': 'Little Bobby Tables', 'id': 1}


----------------------------------------------------------------------
Ran 1 test in 0.002s

FAILED (failures=1)
.. image:: getting_started.png

You can also run your existing `unittest` tests with `marbles`

Expand Down
1 change: 1 addition & 0 deletions docs/changelog.rst
Expand Up @@ -2,6 +2,7 @@
Changelog
=========

* :support:`88` Document how to install with conda
* :release:`0.9.5 <2018-06-24>`
* :support:`80` Added support for ``pandas<0.24``
* :bug:`58` Fixed test failure on OSX
Expand Down
11 changes: 11 additions & 0 deletions docs/install.rst
Expand Up @@ -27,11 +27,22 @@ To install marbles with pip

.. _install-source:

conda
-----

To install marbles with conda

.. code-block:: bash

conda install -c conda-forge marbles

Source
------

If you need a copy of the source, you can clone the `GitHub`_ repository or download the `tarball`_.

.. _GitHub: https://github.com/twosigma/marbles

GitHub
^^^^^^

Expand Down
Binary file added getting_started.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.