# HG changeset patch -- Bitbucket.org
# Project py
# URL http://bitbucket.org/hpk42/py/overview
# User holger krekel <hol...@merlinux.eu>
# Date 1290536723 -3600
# Node ID beee8a9b2fe566759dd381b1e4ce5b83731eaa90
# Parent 85a43322235d4d67a4e1d41226847fa977544291
some doc fixes
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -37,7 +37,7 @@ clean:
-rm -rf $(BUILDDIR)/*
install: clean html
- rsync -avz _build/html/ code:www-pylib/2.0.0
+ rsync -avz _build/html/ code:www-pylib/1.4.0
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -75,17 +75,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the"
\
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
- @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pylib.qhcp"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/py.qhcp"
@echo "To view the help file:"
- @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pylib.qhc"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/py.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
- @echo "# mkdir -p $$HOME/.local/share/devhelp/pylib"
- @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pylib"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/py"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/py"
@echo "# devhelp"
epub:
--- a/doc/install.txt
+++ b/doc/install.txt
@@ -5,7 +5,7 @@
installation info in a nutshell
===================================================
-**PyPI name**: pylib_
+**PyPI name**: py_
**Pythons**: 2.4, 2.5, 2.6, 2.7, 3.0, 3.1.x, Jython-2.5.1, PyPy-1.3
@@ -15,8 +15,7 @@ installation info in a nutshell
**Installers**: ``easy_install`` and ``pip``
-**hg repository**: https://bitbucket.org/hpk42/pylib
-
+**hg repository**: https://bitbucket.org/hpk42/py
easy install
-----------------------------
@@ -24,12 +23,17 @@ easy install
Both `Distribute`_ and setuptools_ provide the ``easy_install``
installation tool with which you can type into a command line window::
- easy_install -U pylib
+ easy_install -U py
to install the latest release of the py lib. The ``-U`` switch
will trigger an upgrade if you already have an older version installed.
-Note that setuptools works ok with Python2 interpreters while `Distribute`_
-additionally works with Python3 and also avoid some issues on Windows.
+
+.. note::
+
+ As of version 1.4 py does not contain py.test anymore - you
+ need to install the new `pytest`_ distribution.
+
+.. _pytest: http://pytest.org
Working from version control or a tarball
-----------------------------------------------
--- a/doc/code.txt
+++ b/doc/code.txt
@@ -2,15 +2,11 @@
py.code: higher level python code and introspection objects
================================================================================
-The ``py.code`` part of the pylib contains some functionality to help
-dealing with Python code objects. Even though working with Python's internal
-code objects (as found on frames and callables) can be very powerful, it's
-usually also quite cumbersome, because the API provided by core Python is
-relatively low level and not very accessible.
-
-The ``py.code`` library tries to simplify accessing the code objects as well
-as creating them. There is a small set of interfaces a user needs to deal with,
-all nicely bundled together, and with a rich set of 'Pythonic' functionality.
+``py.code`` provides higher level APIs and objects for Code, Frame, Traceback,
+ExceptionInfo and source code construction. The ``py.code`` library
+tries to simplify accessing the code objects as well as creating them.
+There is a small set of interfaces a user needs to deal with, all nicely
+bundled together, and with a rich set of 'Pythonic' functionality.
Contents of the library
=======================
@@ -47,7 +43,7 @@ A quick example::
"def read(self, mode='r'):"
.. autoclass:: py.code.Code
- :members:
+ :members:
:inherited-members:
@@ -73,7 +69,7 @@ Example::
'print "foo"'
.. autoclass:: py.code.Source
- :members:
+ :members:
``py.code.Traceback``
@@ -101,7 +97,7 @@ Example::
True
.. autoclass:: py.code.Traceback
- :members:
+ :members:
``py.code.Frame``
--------------------
@@ -123,7 +119,7 @@ Example (using the 'first' TracebackItem
['cls', 'path']
.. autoclass:: py.code.Frame
- :members:
+ :members:
``py.code.ExceptionInfo``
----------------------------
@@ -147,5 +143,5 @@ Example::
"NameError: name 'foobar' is not defined"
.. autoclass:: py.code.ExceptionInfo
- :members:
+ :members:
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
-# pylib documentation build configuration file, created by
+# py documentation build configuration file, created by
# sphinx-quickstart on Thu Oct 21 08:30:10 2010.
#
# This file is execfile()d with the current directory set to its containing
dir.
@@ -40,7 +40,7 @@ source_suffix = '.txt'
master_doc = 'index'
# General information about the project.
-project = u'pylib'
+project = u'py'
copyright = u'2010, holger krekel et. al.'
# The version info for the project you're documenting, acts as replacement for
@@ -166,7 +166,7 @@ html_static_path = ['_static']
#html_file_suffix = None
# Output file base name for HTML help builder.
-htmlhelp_basename = 'pylibdoc'
+htmlhelp_basename = 'py'
# -- Options for LaTeX output
--------------------------------------------------
@@ -180,7 +180,7 @@ htmlhelp_basename = 'pylibdoc'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
[howto/manual]).
latex_documents = [
- ('index', 'pylib.tex', u'pylib Documentation',
+ ('index', 'py.tex', u'py Documentation',
u'holger krekel et. al.', 'manual'),
]
@@ -213,7 +213,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'pylib', u'pylib Documentation',
+ ('index', 'py', u'py Documentation',
[u'holger krekel et. al.'], 1)
]
@@ -223,7 +223,7 @@ autodoc_default_flags = "inherited-membe
# -- Options for Epub output
---------------------------------------------------
# Bibliographic Dublin Core info.
-epub_title = u'pylib'
+epub_title = u'py'
epub_author = u'holger krekel et. al.'
epub_publisher = u'holger krekel et. al.'
epub_copyright = u'2010, holger krekel et. al.'
--- a/doc/index.txt
+++ b/doc/index.txt
@@ -1,12 +1,18 @@
-.. pylib documentation master file, created by
+.. py documentation master file, created by
sphinx-quickstart on Thu Oct 21 08:30:10 2010.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to pylib's documentation!
+Welcome to py's documentation!
=================================
-:ref:`2.0.0 release announcement <release-2.0.0>` and :ref:`CHANGELOG
<changelog>`
+:ref:`1.4.0 release announcement <release-1.4.0>` and :ref:`CHANGELOG
<changelog>`
+
+.. note::
+
+ py.test now comes from the `pytest distribtion`_
+
+.. _`pytest distribution`: http://pypi.python.org/pypi/pytest
Contents:
--- a/doc/announce/release-1.4.0.txt
+++ b/doc/announce/release-1.4.0.txt
@@ -1,7 +1,7 @@
.. _`release-1.4.0`:
-pylib 1.4.0: cross-platform library for path, code, io, ... manipulations
+py-1.4.0: lib for path, code, io, ... manipulations
===========================================================================
"py" is a small library comprising APIs for filesystem and svn path
manipulations,
_______________________________________________
py-svn mailing list
py-svn@codespeak.net
http://codespeak.net/mailman/listinfo/py-svn
