/usr/lib/python3/dist-packages/repoze.sphinx.autointerface-0.8.egg-info/PKG-INFO is in python3-repoze.sphinx.autointerface 0.8-0.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 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | Metadata-Version: 1.1
Name: repoze.sphinx.autointerface
Version: 0.8
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.8 (2016-03-28)
----------------
- Add support for Python 3.3, 3.4, and 3.5.
- Drop support for Python 2.6 and 3.2.
- Allow cross references using the ``:class:`` directive to use the
``.`` for "fuzzy" searching. Thanks to Jason Madden for the patch.
0.7.1 (2012-09-15)
------------------
- Remove ``setup.py`` dependency on ``ez_setup.py``.
0.7.0 (2012-06-20)
------------------
- PyPy compatibility.
- Python 3.2+ compatibility. Thanks to Arfrever for the patch.
- Include interface docs under the ``automodule`` directive. Thanks to
Krys Lawrence for the patch.
0.6.2 (2011-02-13)
------------------
- Fix ``TypeError: 'NoneType' object is not iterable`` error when generating
a rendering of an interface under Python 2.7.
0.6.1 (2011-01-28)
------------------
- Fix ':member-order: bysource' handling.
0.6 (2011-01-28)
----------------
- Correctly handle ':members:' values explicitly set in the directive.
0.5 (2011-01-18)
----------------
- Added support for the ':member-order:' flag, which can take one of the
three stock values, "alphabetical", "groupwise", or "bysource". By
default, members are documented in "hash" order.
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 :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
|