Commits

holger krekel committed beee8a9

some doc fixes

  • Participants
  • Parent commits 85a4332

Comments (0)

Files changed (6)

File doc/Makefile

 	-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
 	@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:

File doc/announce/release-1.4.0.txt

 
 .. _`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,

File doc/code.txt

 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
 =======================
   "def read(self, mode='r'):"
 
 .. autoclass:: py.code.Code
-    :members: 
+    :members:
     :inherited-members:
 
 
   'print "foo"'
 
 .. autoclass:: py.code.Source
-    :members: 
+    :members:
 
 
 ``py.code.Traceback``
   True
 
 .. autoclass:: py.code.Traceback
-    :members: 
+    :members:
 
 ``py.code.Frame``
 --------------------
   ['cls', 'path']
 
 .. autoclass:: py.code.Frame
-    :members: 
+    :members:
 
 ``py.code.ExceptionInfo``
 ----------------------------
   "NameError: name 'foobar' is not defined"
 
 .. autoclass:: py.code.ExceptionInfo
-    :members: 
+    :members:
 
 # -*- 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.
 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
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pylibdoc'
+htmlhelp_basename = 'py'
 
 
 # -- Options for LaTeX output --------------------------------------------------
 # 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'),
 ]
 
 # 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)
 ]
 
 # -- 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.'

File doc/index.txt

-.. 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:
 

File doc/install.txt

 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
 
 
 **Installers**: ``easy_install`` and ``pip``
 
-**hg repository**: https://bitbucket.org/hpk42/pylib
-
+**hg repository**: https://bitbucket.org/hpk42/py
 
 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
 -----------------------------------------------