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