Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update contributor setup docs

  • Loading branch information...
commit 168c1f5867de88c719213dcd400b9a0eab752379 1 parent 23bc5c5
@willkg willkg authored
View
11 docs/dev_documentation.rst
@@ -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
View
4 docs/dev_testing.rst
@@ -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::
View
14 docs/hacking_howto.rst
@@ -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::
Please sign in to comment.
Something went wrong with that request. Please try again.