1. Andriy Kornatskyy
  2. wheezy.html

Commits

Andriy Kornatskyy  committed 42a291e

Working on documentation

  • Participants
  • Parent commits b1e3cf3
  • Branches default

Comments (0)

Files changed (1)

File README

View file
 `wheezy.html`_ is a `python`_ package written in pure Python
-code. It provides python html tags rendering.
+code. It is a lightweight html widget library.
 
 Install
 -------
 
-`wheezy.html`_ requires `python`_ version 2.4 to 2.7 or 3.2.  It
-is independent of operating system. You can install it using
-`setuptools`_::
+`wheezy.html`_ 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.html
+    $ easy_install wheezy.html
+    
+If you are using `virtualenv`_::
 
+    $ virtualenv env
+    $ env/bin/easy_install wheezy.html
 
 Develop
 -------
 
-Get the `source code`_ using `mercurial`_::
+You can get the `source code`_ using `mercurial`_::
 
-    hg clone https://bitbucket.org/akorn/wheezy.html
-    cd wheezy.html
+    $ hg clone http://bitbucket.org/akorn/wheezy.html
+    $ cd wheezy.html
 
-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.
-
 .. _`wheezy.html`: http://pypi.python.org/pypi/wheezy.html
+.. _`pypi`: http://pypi.python.org/pypi/wheezy.html
 .. _`python`: http://www.python.org
 .. _`setuptools`: http://pypi.python.org/pypi/setuptools
-.. _`documented`: http://packages.python.org/wheezy.html
-.. _`examples`: https://bitbucket.org/akorn/wheezy.html/src/tip/demos/
-.. _`bitbucket`: https://bitbucket.org/akorn/wheezy.html
-.. _`source code`: https://bitbucket.org/akorn/wheezy.html/src
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.html/issues
+.. _`source code`: http://bitbucket.org/akorn/wheezy.html/src
 .. _`mercurial`: http://mercurial.selenic.com/
-.. _`user guide`: http://packages.python.org/wheezy.html/userguide.html
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`article`: http://mindref.blogspot.com/2011/09/compile-python-from-source.html
+.. _`mind reference`: http://mindref.blogspot.com/
+.. _`doctest`: http://docs.python.org/library/doctest.html
+.. _`sphinx`: http://sphinx.pocoo.org/