diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-03-25 14:29:35 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-03-25 14:29:35 -0400 |
| commit | 98396cfb5ad628b17f395d190362168da25afbd8 (patch) | |
| tree | e6d3d8dfd98661f142c717105e0e1b175ec72107 /docs | |
| parent | 7bc7e3ca07980be9ed1fe5699fdacc2191bb6969 (diff) | |
| download | passlib-98396cfb5ad628b17f395d190362168da25afbd8.tar.gz | |
updated links in documentation; bumped to version 1.3.01.3.0
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/history.rst | 2 | ||||
| -rw-r--r-- | docs/index.rst | 8 | ||||
| -rw-r--r-- | docs/install.rst | 35 |
3 files changed, 28 insertions, 17 deletions
diff --git a/docs/history.rst b/docs/history.rst index 6cfc820..99f9adb 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,7 +2,7 @@ Release History =============== -**1.3** (To Be Released) +**1.3** (2011-03-25) * first public release * documentation completed diff --git a/docs/index.rst b/docs/index.rst index 46cfc34..7a6acce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,3 +43,11 @@ Quick Links </td> </tr> </table> + +Online Resources +================ +* **Homepage**: `<http://code.google.com/p/passlib/>`_. +* **Downloads**: `<http://code.google.com/p/downloads/>`_. +* **PyPI**: `<http://pypi.python.org/pypi/passlib/>`_. +* **Docs**: `<http://packages.python.org/passlib/>`_. +* **Source**: `<http://code.google.com/p/passlib/source/>`_ diff --git a/docs/install.rst b/docs/install.rst index 8837e6f..fb99468 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -58,19 +58,22 @@ Once PassLib and Nose have been installed, the tests may be run from the source # to run all tests... PASSLIB_TESTS="all" nosetests -v passlib/tests -Documentation -============= -The latest copy of this documentation should always be available -at the `PassLib homepage <http://www.assurancetechnologies.com/software/passlib>`_. - -If you wish to generate your own copy of the documentation, -you will need to: - -* install `Sphinx <http://sphinx.pocoo.org/>`_ (1.0 or better) -* install `astdoc <http://www.assurancetechnologies.com/software/astdoc>`_ (a bundle of custom sphinx themes & extensions - used by Assurance Technologies). -* download the PassLib source -* run :samp:`python docs/make.py clean html`. - -Once Sphinx completes it's run, point a web browser to the file at :samp:`docs/_build/html/index.html` -to access the PassLib documentation in html format. +.. + NOTE: commented this out from published manual, until astdoc package is cleaned up + + Documentation + ============= + The latest copy of this documentation should always be available + online at `<http://packages.python.org/passlib>`_. + + If you wish to generate your own copy of the documentation, + you will need to: + + * install `Sphinx <http://sphinx.pocoo.org/>`_ (1.0 or better) + * install `astdoc <XXX url not available yet XXX>`_ (a bundle of custom sphinx themes & extensions + used by Assurance Technologies). + * download the PassLib source + * run :samp:`python docs/make.py clean html`. + + Once Sphinx completes it's run, point a web browser to the file at :samp:`docs/_build/html/index.html` + to access the PassLib documentation in html format. |