CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-03 14:54:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Initial documentation

Browse Source
This commit is contained in:
Raphael Michel
2014-09-08 15:54:08 +02:00
parent 820a68163d
commit 4689bdf337
10 changed files with 793 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/development/setup.rst Normal file
View File

@@ -0,0 +1,32 @@
The development setup
=====================
Obtain a copy of the source code
--------------------------------
Just clone our git repository::
git clone https://github.com/tixl/tixl.git
cd tixl/
Your local python environment
-----------------------------
Please execute ``python -V`` or ``python3 -V`` to make sure you have Python 3.4 installed. Also make sure you have pip for Python 3 installed, you can execute ``pip3 -V`` to check. Then use Python 3.4's internal tools to create a virtual environment and activate it for your current session::
pyvenv env
source env/bin/activate
You should now see a ``(env)`` prepended to your shell prompt.
Working with the documentation
------------------------------
First, you should install the requiremente necessary for building the documentation. Make sure you have your virtual python enviroment activated (see above). Then, install the packages by executing::
cd doc/
pip install -r requirements.txt
To build the documentation, run the following command from the ``doc/`` directory::
make html
You will now find the generated documentation in the ``doc/_build/html/`` subdirectory.