Commit a4e818bb authored by bue's avatar bue
Browse files

@ annot : still writing documentation with sphinx.

parent 8a80ed3f
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ The source code is distributed under the free and open source AGPLv3 license.
Contents:

.. toctree::
    :maxdepth: 2
    :maxdepth: 3

    man_introduction
    man_use
+25 −3
Original line number Diff line number Diff line
@@ -9,8 +9,8 @@ You can skip step 4 and staight git clone git\@gitlab.com:biotransistor/annot.gi
How-to Get Annot Developer version Up and Running
-------------------------------------------------

Install Annot
^^^^^^^^^^^^^
Install Annot for Development
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1. `Install Docker <https://docs.docker.com/>`_ on the computer you would like to run Annot for development. (This can be the same at the computer where you run your deployed version of Annot.)
    Docker is able runs on Linux, Mac OSX, MS Windos and many flavours of cloud platforms.
@@ -50,4 +50,26 @@ Install Annot
    docker run --name=media elmar/media /bin/true
    docker run --name=apache_annotdev --volumes-from=media -v=/path/to/annot:/var/www/annot -v=/path/to/crowbar.py:/var/www/annot/prjannot/crowbar.py -d -p 35627:80 elmar/apache_annot

8. With apache_annotdev docker container continuer with step 6 to 9 form the User Manual Install Annot instruction.
8. With apache_annotdev docker container continuer with :ref:`step 6 to 9 form the User Manual Install Annot <link_developmer_manual>` instruction.

   
Run Annot for Development
^^^^^^^^^^^^^^^^^^^^^^^^^

* In one shell manipulat Annot source code on host server rund apache_annotdev. Changein to the source code will imidiately take effect. Hint: if the host is not your local computer ssh into the host server to work with the source code. 

* In an other shell enter apache_annot to controll the apache web server. The following commands might be of use: ::

    docker exec -ti apache_annot /bin/bash
    
    /etc/init.d/postgresql
    /etc/init.d/postgresql status
    /etc/init.d/postgresql start
    /etc/init.d/postgresql restart
    /etc/init.d/postgresql stop

* Don't forget to add, commit, and push your changes to your git repository. And if your code runs, don't forget to merge request that the changes can be forked back into the official repository.


Style Guide
-----------
+5 −1
Original line number Diff line number Diff line
@@ -4,13 +4,17 @@ Epilog
Get Help
--------

Bug and Issue?
--------------

Author List
-----------
In alphabetic order:

Carly King: documentation work
Elmar Bucher (bue): main programmer

Laura Heiser: principal investigator
Mark Dane: concept input

Aknowledgement
--------------
+4 −2
Original line number Diff line number Diff line
@@ -36,6 +36,8 @@ Install Annot
    docker run --name=annot elmar/annot /bin/true
    docker run --name=apache_annot --volumes-from=media --volumes-from=annot -v=/path/to/crowbar.py:/var/www/annot/prjannot/crowbar.py -d -p 52872:80 elmar/apache_annot

.. _link_developmer_manual:

6. Figure out the hostname or IP address from the machine you are running docker.
   Check out the `Docker installation documentation <https://docs.docker.com/>`_ for detailed informaton how to do this.
   For the rest of the documentation we assume IP address 127.0.0.1 .