/usr/share/pyshared/repoze.sphinx.autointerface-0.4.egg-info/PKG-INFO is in python-repoze.sphinx.autointerface 0.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 | Metadata-Version: 1.0
Name: repoze.sphinx.autointerface
Version: 0.4
Summary: Sphinx extension: auto-generates API docs from Zope interfaces
Home-page: http://www.repoze.org
Author: Agendaless Consulting
Author-email: repoze-dev@lists.repoze.org
License: BSD-derived (http://www.repoze.org/LICENSE.txt)
Description: repoze.sphinx.autointerface README
==================================
Overview
--------
Thie package defines an extension for the
`Sphinx <http://sphinx.pocool.org>`_ documentation system. The extension
allows generation of API documentation by introspection of
`zope.interface <http://pypi.python.org/pypi/zope.interface>`_ instances in
code.
Installation
------------
Install via `easy_install
<http://peak.telecommunity.com/DevCenter/EasyInstall>`_::
$ bin/easy_install repoze.sphinx.autointerface
or any other means which gets the package on your ``PYTHONPATH``.
Registering the Extension
-------------------------
Add ``repoze.sphinx.autointerface`` to the ``extensions`` list in the
``conf.py`` of the Sphinx documentation for your product. E.g.::
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'repoze.sphinx.autointerface',
]
Using the Extension
-------------------
At appropriate points in your document, call out the interface
autodocs via::
.. autointerface:: yourpackage.interfaces.IFoo
Output from the directive includes
- the fully-qualified interface name
- any base interfaces
- the doctstring from the interface, rendered as reSTX.
- the members of the interface (methods and attributes).
* For each attribute, the output includes the attribute name
and its description.
* For each method, the output includes the method name, its signature,
and its docstring (also rendered as reSTX).
repoze.sphinx.autointerface Changelog
=====================================
0.4 (2010-07-26)
----------------
- Fixed compatibility with Sphinx 1.0
- Un-break PyPI ReST/HTML-rendering again.
0.3 (2009-10-25)
----------------
- Refactor sphinx integration. There are now separate ``autointerface``
and ``interface`` directives.
0.2.1 (2009-08-20)
------------------
- Fix add_directive arguments to work with Sphinx 0.6.1, now required.
0.1.3 (2009-01-14)
------------------
- Coerce unicode path elements to str in ``_resolve_dotted_name``.
Note that non-ASCII path elements won't work: this fix just deals
with the case where the path was of type unicode.
- Fixed spelling of directive in README.txt.
- Added dependency on ``zope.interface``.
0.1.2 (2008-10-03)
------------------
- Packaging change: improved description in README.txt.
0.1.1 (2008-10-03)
------------------
- Packaging bug: the ``long_description`` was not rendering properly to
HTML on PyPI.
0.1 (2008-10-02)
----------------
- Initial release.
Keywords: web wsgi zope
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
|