summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--ChangeLog10
-rw-r--r--docs/gnu.rst13
-rw-r--r--docs/index.rst5
-rw-r--r--docs/osx.rst28
-rw-r--r--docs/setup-combox.rst28
-rw-r--r--docs/windows.rst114
6 files changed, 9 insertions, 189 deletions
diff --git a/ChangeLog b/ChangeLog
index 5356af4..a30f0c0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,8 +1,14 @@
2015-12-24 Siddharth Ravikumar <sravik@bgsu.edu>
* setup.py: updated `description`.
- * docs/api/combox.crypto.rst: Added
- * docs/releases.rst: Added
+ * docs/index.rst: Removed gnu, osx, windows, setup-combox from
+ toctree; Added releases to toctree.
+ * docs/gnu.rst: Removed.
+ * docs/osx.rst: Removed.
+ * docs/setup-combox.rst: Removed.
+ * docs/windows.rst: Removed.
+ * docs/releases.rst: Added.
+ * docs/api/combox.crypto.rst: Added.
* docs/api/index.rst: Added api/combox.crypto, docs/releases to toctree.
* combox/crypto.py: Rewrote all docstrings; they're sphinx
friendly now.
diff --git a/docs/gnu.rst b/docs/gnu.rst
deleted file mode 100644
index fbb2cbe..0000000
--- a/docs/gnu.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-============
-on gnu/linux
-============
-
-.. highlight:: bash
-
-Install ``virtualenv`` and python dev. package.
-
-On a Debian based distribution, do::
-
- # aptitude install virtualenv python-dev
-
-See :doc:`setup-combox` for setting up combox in ``develop`` mode.
diff --git a/docs/index.rst b/docs/index.rst
index 6341152..aeac543 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,9 +5,6 @@
.. toctree::
:hidden:
- gnu
- osx
- windows
- setup-combox
+ setup/index
releases
api/index
diff --git a/docs/osx.rst b/docs/osx.rst
deleted file mode 100644
index b107ad9..0000000
--- a/docs/osx.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-=======
-on os x
-=======
-
-.. highlight:: bash
-
-First install Hombrew_::
-
- $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-
-.. _Hombrew: http://brew.sh/
-
-Then do::
-
- $ brew update
- $ brew doctor
-
-Next, install python from Hombrew_::
-
- $ brew install python
-
-This will also install ``pip``.
-
-Install ``virtualenv`` from ``pip``::
-
- $ pip install virtualenv
-
-See :doc:`setup-combox` for setting up combox in ``develop`` mode.
diff --git a/docs/setup-combox.rst b/docs/setup-combox.rst
deleted file mode 100644
index d189d67..0000000
--- a/docs/setup-combox.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-=============
-setup combox
-=============
-
-.. highlight:: bash
-
-Get the latest copy of combox::
-
- $ git clone git://ricketyspace.net/combox.git
-
-Setup virtual environment::
-
- $ cd combox
- $ virtualenv .
-
-Activate the virtual environment::
-
- $ source bin/activate
-
-Install combox in ``develop`` mode::
-
- $ python setup.py develop
-
-Always make sure that the virtual environment is activated before
-running combox. To activate virtual environment, do::
-
- $ cd path/to/combox
- $ source bin/activate
diff --git a/docs/windows.rst b/docs/windows.rst
deleted file mode 100644
index 99a3cb8..0000000
--- a/docs/windows.rst
+++ /dev/null
@@ -1,114 +0,0 @@
-==========
-on windows
-==========
-
-.. highlight:: powershell
-
-At the moment, ``combox`` is not compatible with Windows. The following
-sections describe how to set up the development environment on
-Windows.
-
-
-setup python, pip and virtualenv
---------------------------------
-
-Install python v2.7.x first: `python.org/downloads/windows`__
-
-.. _pywindows: https://www.python.org/downloads/windows
-.. __: pywindows_
-
-Add python to ``PATH``:
-
-.. code-block:: none
-
- %PATH%;C:\Python27
-
-Make sure python works from Windows Powershell
-
-Get a copy of `get-pip.py`_.
-
-.. _get-pip.py: https://raw.githubusercontent.com/pypa/pip/master/contrib/get-pip.py
-
-From Windows Powershell, ``cd`` to the directory containing
-``get-pip.py`` file and do::
-
- python get-pip.y
-
-That should install ``pip`` and ``setuptools``.
-
-Next, add pip to ``PATH``:
-
-.. code-block:: none
-
- %PATH%;C:\Python27;C:\Python27\Scripts
-
-Make sure ``pip`` works from Windows Powershell by doing::
-
- pip --version
-
-Lastly, install ``virtualenv``::
-
- pip install virtualenv
-
-
-install git
------------
-
-Get a copy of ``git`` from `git-scm.com/download/win`__
-
-.. _gitwin: http://git-scm.com/download/win
-.. __: gitwin_
-
-In the "Adjusting your PATH environment" screen in the ``git``
-installation wizard, choose the "Use Git from the Windows Command
-Prompt"
-
-Make sure ``git`` works from Windows Powershell by doing::
-
- git --version
-
-
-setup combox
-------------
-
-
-install v. c++ compiler
-=======================
-
-From `aka.ms/vcpython27`__ (this is required for installing
-``pycrypto`` package from ``pip``).
-
-.. _vcpython27: http://aka.ms/vcpython27
-.. __: vcpython27_
-
-
-setup combox
-==============
-
-From the Windows Powershell, do::
-
- git clone git://ricketyspace.net/combox.git
-
-
-setup virtual environment
-.........................
-
-``cd`` to the ``combox`` directory and do::
-
- virtualenv .
-
-
-activate virtual environment
-............................
-
-``cd`` to the ``combox`` directory and do::
-
- .\Scripts\activate
-
-
-install combox
-..............
-
-in ``develop`` mode::
-
- python setup.py develop