Statistics
| Branch: | Tag: | Revision:

root / README @ a4c10cbc

History | View | Annotate | Download (523 Bytes)

1 f2d7b5ab Antony Chazapis
Documentation
2 f2d7b5ab Antony Chazapis
-------------
3 f2d7b5ab Antony Chazapis
4 f2d7b5ab Antony Chazapis
To build the documentation you need to have Sphinx installed:
5 f2d7b5ab Antony Chazapis
http://sphinx.pocoo.org/
6 f2d7b5ab Antony Chazapis
7 f2d7b5ab Antony Chazapis
Run:
8 f2d7b5ab Antony Chazapis
    python setup.py build_sphinx
9 f2d7b5ab Antony Chazapis
10 3f839f59 Antony Chazapis
The documentation will be built in the docs/build/html directory.
11 f2d7b5ab Antony Chazapis
12 f2d7b5ab Antony Chazapis
Also run:
13 f2d7b5ab Antony Chazapis
    python setup.py build_sphinx -b text
14 f2d7b5ab Antony Chazapis
15 3f839f59 Antony Chazapis
Then find the plain text version of the docs in docs/build/text.
16 f2d7b5ab Antony Chazapis
17 f2d7b5ab Antony Chazapis
Running the server
18 f2d7b5ab Antony Chazapis
------------------
19 f2d7b5ab Antony Chazapis
20 f2d7b5ab Antony Chazapis
Enter the pithos dir and run:
21 f2d7b5ab Antony Chazapis
    python manage.py runserver
22 f2d7b5ab Antony Chazapis
23 f2d7b5ab Antony Chazapis
This server is useful during development, but should not be used for deployment.