docs: richer documentation #14
Conversation
* Enriches documentation by the information taken from wiki pages. Useful for future plugging into Read The Docs. (addresses #13) * Note: the information is taken rather literally so far, modulo formatting changes. An update of the documentation content, reflecting the recent code base changes is still to come. Signed-off-by: Tibor Simko <[email protected]>
|
This PR takes all wiki pages and integrates them in the docs. The current table of contents looks like below. There is a potential for reorganising to streamline the docs, but that's for another PR. P.S. It would be good to create http://timegate.readthedocs.io/ for easy reading of docs, as well as to enable the Read The Docs service integration hook on GitHub.
|
|
|
||
| Requirements | ||
| ------------ | ||
| pip install -e git+https://github.com/mementoweb/timegate.git#egg=TimeGate |
There was a problem hiding this comment.
This command does not install uwsgi, as a result the following command does not work out of the box, unless uwsgi is installed separately.
There was a problem hiding this comment.
For the time being I have not amended any instructions, I have only copied existing INSTALL.rst. This we better amend separately. BTW, the proper pip example instruction would be:
$ pip install -e git+https://github.com/mementoweb/timegate.git#egg=TimeGate[uwsgi]This would install uwsgi too.
There was a problem hiding this comment.
Shouldn't it be:
pip install -e "git+https://github.com/mementoweb/timegate.git#egg=TimeGate[uwsgi]"
There was a problem hiding this comment.
@tiborsimko you beat me by a fraction of a minute. ;-)
Useful for future plugging into Read The Docs. (addresses Documentation Updates #13)
formatting changes. An update of the documentation content, reflecting
the recent code base changes is still to come.
Signed-off-by: Tibor Simko [email protected]