Changes to the documentation

- added GitHub Mirrors in README and installing guide.
- added thanks.
- added descriptors, description and scripts in setup.
- corrected version in setup.py.
- Added github pages to Makefile and separated glugcen upload.

README

@@ -6,64 +6,13 @@ Lantz is an automation and instrumentation toolkit with a clean, well-designed a
 Lantz aim to provide a library of curated and well documented instruments drivers. We have some already, let us know if you cannot find yours.
 
 
-Getting Lantz
--------------
+For more information, check out the documentation:
 
-Lantz core requires only Python 3.2+. This guide also assumes that you have installed `virtualenv` and `pip`. If not, please install them by typing::
+http://lantz.glugcen.dc.uba.ar/
 
-    $ easy_install virtualenv pip
-
-(By the way, check out virtualenv wrapper as a way to easy handle your virtual environments)
-
-Some lantz submodules have other requirements.
-
-   - Colorama: `pip install colorama`
-
-   - Sphinx: `pip install sphinx`
-
-   - pySerial: use a binary package or `pip install pyserial`
-
-   - NumPy: use a binary package or `pip install numpy`
-
-   - Qt: use a binary package
-
-   - pyQt: use a binary package or `pip install pyqt`
-
-
-If you only plan to use Lantz and you have `pip` installed you can::
-
-    $ pip install XXXX
-
-and you are ready to go.
-
-
-But most Lantz users are also developers so it is very likely that you want to do it differently. First, create a virtual environment in your directory of choice::
-
-    $ virtualenv -p python3 lantzenv
-    $ cd lantzenv
-    $ source bin/activate
-
-and then install an editable package
-
-    $ pip install -e git+XXXX#egg=lantz
-
-
-Building the documentation
---------------------------
-
-You can build your own off-line documentation::
-
-    $ cd docs
-    $ make html
-
-Your newly created documentation will be in `_build/html/index.html`
-
-
-Where to go from here
----------------------
-
-Check the tutorial in the documentation!
+or in the GitHub Mirror:
 
+http://hgrecco.github.com/lantz/
 
 
 The Lantz Authors

docs/Makefile

@@ -142,6 +142,18 @@ all:
 	rm -rf _build/latex
 	rm -rf _build/epub
 
-upload:
-	$(MAKE) all
+glug:
 	cd _build/html; rsync -a . hgrecco@glugcen.dc.uba.ar:/var/www/lantz/
+
+github:
+	rm -rf ~/tmp/lantz-docs
+	git clone -b gh-pages git@github.com:hgrecco/lantz.git ~/tmp/lantz-docs
+	cd ~/tmp/lantz-docs; \
+	rm -rf *
+	cp -rf _build/html/ ~/tmp/lantz-docs
+	cd ~/tmp/lantz-docs; \
+	touch .nojekyll ; \
+	git add . ; \
+	git commit -a -m "Updated the docs" ; \
+	git push origin gh-pages;
+	rm -rf ~/tmp/lantz-docs

docs/_templates/sidebarintro.html

@@ -14,6 +14,12 @@ <h3>Other Formats</h3>
 <h3>Useful Links</h3>
 <ul>
   <li><a href="http://glugcen.dc.uba.ar/mailman/listinfo/lantz">Discussion list</a></li>
-  <li><a href="http://trac.glugcen.dc.uba.ar">Issue Tracker</a></li>
+  <li><a href="https://github.com/hgrecco/lantz">Issue Tracker</a></li>
 </ul>
+<h3>Mirrors</h3>
+<ul>
+    <li><a href="https://github.com/hgrecco/lantz">Code in GitHub</a></li>
+    <li><a href="http://hgrecco.github.com/lantz/">Docs in GitHub</a></li>
+</ul>
+