Skip to content
This repository has been archived by the owner on Feb 20, 2019. It is now read-only.

Commit

Permalink
Update contributor setup docs
Browse files Browse the repository at this point in the history
  • Loading branch information
willkg committed Jun 3, 2013
1 parent 23bc5c5 commit 168c1f5
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
11 changes: 8 additions & 3 deletions docs/dev_documentation.rst
Expand Up @@ -16,9 +16,14 @@ always up to date.

Also, of extreme high-priority hyperbole-ignoring importance:

* *ElasticSearch* (camel-case) refers to the pyelasticsearch ElasticSearch
class and instances.
* *Elasticsearch* (no camel-case) is the Elasticsearch software.
*ElasticSearch* (camel-case)

Refers to the pyelasticsearch ElasticSearch
class and instances.

*Elasticsearch* (no camel-case)

The Elasticsearch software.


Building the docs
Expand Down
4 changes: 2 additions & 2 deletions docs/dev_testing.rst
Expand Up @@ -9,8 +9,8 @@ You can run the tests with::

./run_tests.py

If you have Django installed, this will run the Django-specific tests. If you
don't, then the test runner will skip the Django-specific tests.

This will run all the tests.


.. Note::
Expand Down
14 changes: 6 additions & 8 deletions docs/hacking_howto.rst
Expand Up @@ -12,24 +12,22 @@ should check out :ref:`users-guide`.
External requirements
=====================

You should have `elasticsearch <http://elasticsearch.org/>`_ installed
You should have `Elasticsearch <http://elasticsearch.org/>`_ installed
and running.


Get dependencies
================
Install dependencies
====================

Run::

$ virtualenv ./venv/
$ virtualenv ./venv
$ . ./venv/bin/activate
$ pip install -r requirements-dev.txt
$ python setup.py develop

If you want to work on the contrib.django bits, you also need to do::

$ pip install -r requirements-django.txt

This sets up all the required dependencies for development of ElasticUtils.
This sets up the required dependencies for development of ElasticUtils.

.. Note::

Expand Down

0 comments on commit 168c1f5

Please sign in to comment.