diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 23 | ||||
-rw-r--r-- | docs/install/index.rst | 39 |
2 files changed, 44 insertions, 18 deletions
diff --git a/docs/index.rst b/docs/index.rst index c95a198..c3203a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,22 +1,9 @@ -.. lpschedule-generator documentation master file, created by - sphinx-quickstart on Wed May 11 19:54:18 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. highlight:: bash -Welcome to lpschedule-generator's documentation! -================================================ - -Contents: +.. include:: ../README.rst .. toctree:: - :maxdepth: 2 - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + :hidden: + Home <self> + install/index diff --git a/docs/install/index.rst b/docs/install/index.rst new file mode 100644 index 0000000..7a4fe0b --- /dev/null +++ b/docs/install/index.rst @@ -0,0 +1,39 @@ +Installation +------------ + +On a Debian based distribution, do:: + + # aptitude install virtualenv python-setuptools + +Install globally +~~~~~~~~~~~~~~~~ + +:: + + $ sudo pip install lpschedule-generator + + +Install locally using virtualenv (Recommended) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Make a separate ``lpschedule-generator`` directory and initialize the +virtual environment in it:: + + $ mkdir lpschedule-generator + $ cd lpschedule-generator + + $ virtualenv . + $ source bin/activate + +Install ``lpschedule-generator`` inside this directory using ``pip``:: + + $ pip install lpschedule-generator + +Activating virtual environment +`````````````````````````````` + +Always activate the virtual environment before using the ``lps_gen`` +command:: + + $ cd path/to/lpschedule-generator + $ source bin/activate |