summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/Makefile7
-rw-r--r--doc/installation.rst23
-rw-r--r--requirements-dev-py2x.txt5
-rw-r--r--requirements-dev-py3x.txt5
4 files changed, 30 insertions, 10 deletions
diff --git a/doc/Makefile b/doc/Makefile
index 397d629..5eaf772 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -130,3 +130,10 @@ doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
+
+upload: html
+ @echo
+ @echo "UPLOADING to webserver"
+ @echo
+ rsync _build/html/* sybren@stuvel.eu:stuvel.eu/manager/files/python-rsa-doc/ -va
+
diff --git a/doc/installation.rst b/doc/installation.rst
index 0880d6f..afe093f 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -41,19 +41,22 @@ Development dependencies
--------------------------------------------------
In order to start developing on Python-RSA you need a bit more. Use
-pip or easy_install to install the following packages:
+pip to install the development requirements in a virtual environment
+for Python 2.x::
- - Mercurial
- - nose
- - sphinx
- - pyasn1
- - tox
- - unittest2 (Python 2.x) or unittest2py3k (Python 3.x)
+ virtualenv python-rsa-venv-py2x
+ . python-rsa-venv-py2x/bin/activate
+ pip install -r python-rsa/requirements-dev-py2x.txt
-Once these are installed, use Mercurial_ to get a copy of the source::
+or Python 3.x::
+
+ virtualenv python-rsa-venv-py3x
+ . python-rsa-venv-py3x/bin/activate
+ pip install -r python-rsa/requirements-dev-py3x.txt
- hg clone https://sybren@bitbucket.org/sybren/python-rsa
- sudo python setup.py develop
+Once these are installed, use Mercurial_ to get a copy of the source::
+ hg clone https://bitbucket.org/sybren/python-rsa
+ python setup.py develop
.. _Mercurial: http://hg-scm.com/
diff --git a/requirements-dev-py2x.txt b/requirements-dev-py2x.txt
new file mode 100644
index 0000000..c62d8c0
--- /dev/null
+++ b/requirements-dev-py2x.txt
@@ -0,0 +1,5 @@
+nose
+sphinx
+pyasn1>=0.1.3
+tox
+unittest2
diff --git a/requirements-dev-py3x.txt b/requirements-dev-py3x.txt
new file mode 100644
index 0000000..731ef74
--- /dev/null
+++ b/requirements-dev-py3x.txt
@@ -0,0 +1,5 @@
+nose
+sphinx
+pyasn1>=0.1.3
+tox
+unittest2py3k