Commits

Andriy Kornatskyy committed d74f959

Working on documentation

Comments (0)

Files changed (2)

-`wheezy.web`_ is a `python`_ package written in pure Python
-code. It provides web features.
+`wheezy.web`_ is a `python`_ package written in pure Python code. 
+It is a lightweight `WSGI`_ web framework.
+
+It is optimized for performance, well tested and documented.
+
+Resources:
+
+* `source code`_, `examples`_ and `issues`_ tracker are available
+  on `bitbucket`_
+* `documentation`_, `readthedocs`_
+* `eggs`_ on `pypi`_
 
 Install
 -------
 
-`wheezy.web`_ requires `python`_ version 2.4 to 2.7 or 3.2.  It
-is independent of operating system. You can install it using
-`setuptools`_::
+`wheezy.web`_ requires `python`_ version 2.4 to 2.7 or 3.2.
+It is independent of operating system. You can install it from `pypi`_ 
+site using `setuptools`_::
 
-    easy_install wheezy.web
+    $ easy_install wheezy.web
+    
+If you are using `virtualenv`_::
 
+    $ virtualenv env
+    $ env/bin/easy_install wheezy.web
 
 Develop
 -------
 
-Get the `source code`_ using `mercurial`_::
+You can get the `source code`_ using `mercurial`_::
 
-    hg clone https://bitbucket.org/akorn/wheezy.web
-    cd wheezy.web
+    $ hg clone http://bitbucket.org/akorn/wheezy.web
+    $ cd wheezy.web
 
-Prepare virtualenv environment in *env* directory and run all
-tests for python2.6 (default)::
+Prepare `virtualenv`_ environment in *env* directory ::
 
-    make env test VERSION=2.6
+    $ make env
 
-doctests can be run with python3.2::
+... and run all tests::
 
-    make env doctest-cover VERSION=3.2
+    $ make test
+
+You can read how to compile from source code different versions of 
+`python`_ in the `article`_ published on `mind reference`_ blog.
+
+You can run certain make targets with specific python version. Here
+we are going to run `doctest`_ with python3.2::
+
+    $ make env doctest-cover VERSION=3.2
+    
+Generate documentation with `sphinx`_::
+
+	$ make doc
 
 If you run into any issue or have comments, go ahead and add on
 `bitbucket`_.
 
-User Guide and Examples
------------------------
-
-Please see the `user guide`_ and `examples`_ for more
-information.
-
+.. _`article`: http://mindref.blogspot.com/2011/09/compile-python-from-source.html
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.web
+.. _`doctest`: http://docs.python.org/library/doctest.html
+.. _`documentation`: http://packages.python.org/wheezy.web
+.. _`eggs`: http://pypi.python.org/pypi/wheezy.web
+.. _`examples`: http://bitbucket.org/akorn/wheezy.web/src/tip/demos
+.. _`issues`: http://bitbucket.org/akorn/wheezy.web/issues
+.. _`mercurial`: http://mercurial.selenic.com/
+.. _`mind reference`: http://mindref.blogspot.com/
+.. _`pypi`: http://pypi.python.org/pypi/wheezy.web
+.. _`python`: http://www.python.org
+.. _`readthedocs`: http://readthedocs.org/builds/wheezyweb/
+.. _`setuptools`: http://pypi.python.org/pypi/setuptools
+.. _`source code`: http://bitbucket.org/akorn/wheezy.web/src
+.. _`sphinx`: http://sphinx.pocoo.org/
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
 .. _`wheezy.web`: http://pypi.python.org/pypi/wheezy.web
-.. _`python`: http://www.python.org
-.. _`setuptools`: http://pypi.python.org/pypi/setuptools
-.. _`documented`: http://packages.python.org/wheezy.web
-.. _`examples`: https://bitbucket.org/akorn/wheezy.web/src/tip/demos/
-.. _`bitbucket`: https://bitbucket.org/akorn/wheezy.web
-.. _`source code`: https://bitbucket.org/akorn/wheezy.web/src
-.. _`mercurial`: http://mercurial.selenic.com/
-.. _`user guide`: http://packages.python.org/wheezy.web/userguide.html
+.. _`WSGI`: http://www.python.org/dev/peps/pep-3333
 
 * `source code`_, `examples`_ and `issues`_ tracker are available
   on `bitbucket`_
-* `documentation`_
+* `documentation`_, `readthedocs`_
 * `eggs`_ on `pypi`_
 
 Contents
    userguide
    modules
 
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.web
+.. _`documentation`: http://packages.python.org/wheezy.web
+.. _`eggs`: http://pypi.python.org/pypi/wheezy.web
+.. _`examples`: http://bitbucket.org/akorn/wheezy.web/src/tip/demos
+.. _`issues`: http://bitbucket.org/akorn/wheezy.web/issues
+.. _`pypi`: http://pypi.python.org
 .. _`python`: http://www.python.org
+.. _`readthedocs`: http://readthedocs.org/builds/wheezyweb/
+.. _`source code`: http://bitbucket.org/akorn/wheezy.web/src
 .. _`WSGI`: http://www.python.org/dev/peps/pep-3333
-.. _`source code`: http://bitbucket.org/akorn/wheezy.web/src
-.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.web
-.. _`issues`: http://bitbucket.org/akorn/wheezy.web/issues
-.. _`documentation`: http://packages.python.org/wheezy.web
-.. _`examples`: http://bitbucket.org/akorn/wheezy.web/src/tip/demos
-.. _`pypi`: http://pypi.python.org
-.. _`eggs`: http://pypi.python.org/pypi/wheezy.web