.. image:: https://readthedocs.org/projects/zopeappapidoc/badge/?version=latest
:target: https://zopeappapidoc.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://github.com/zopefoundation/zope.app.apidoc/actions/workflows/tests.yml/badge.svg
:target: https://github.com/zopefoundation/zope.app.apidoc/actions/workflows/tests.yml
:alt: Build Status
.. image:: https://coveralls.io/repos/github/zopefoundation/zope.app.apidoc/badge.svg?branch=master
:target: https://coveralls.io/github/zopefoundation/zope.app.apidoc?branch=master
:alt: Code Coverage
This Zope 3 package provides fully dynamic API documentation of Zope 3 and
registered add-on components. The package is very extensible and can be easily
extended by implementing new modules.
Documentation is available at https://zopeappapidoc.readthedocs.io/
=========
CHANGES
=========
5.0 (2023-07-06)
================
- Drop support for Python 2.7, 3.5, 3.6.
- Add support for Python 3.11.
4.3.0 (2021-12-15)
==================
- Add support for Python 3.8, 3.9 and 3.10.
- Drop support for Python 3.4.
4.2.0 (2018-08-21)
==================
- Add support for Python 3.7.
- The root ``Code`` documentation node no longer allows incidental
traversal and documentation of unregistered root modules such as
``re`` and ``logging`` (``builtins`` is special cased). These were
not listed in the tables of contents or menus, and mostly served to
slow down static exports. To document a root module, explicitly
include it in ZCML with ``<apidoc:rootModule module="MODULE" />``.
See `issue #20
<https://github.com/zopefoundation/zope.app.apidoc/issues/20>`_.
- Fix ``codemodule.Module`` for modules that have a ``__file__`` of
``None``. This can be the case with namespace packages, especially
under Python 3.7. See `issue #17 <https://github.com/zopefoundation/zope.app.apidoc/issues/17>`_.
- Rendering documentation for a class that has a ``__doc__`` property
no longer fails but produces a descriptive message. See `issue 16
<https://github.com/zopefoundation/zope.app.apidoc/issues/16>`_.
- Host documentation at https://zopeappapidoc.readthedocs.io/
- Add argument to ``static-apidoc`` for loading a specific ZCML file. To use this feature, the ZCML file you specify needs to
establish a working Zope 3 publication environment. The easiest way to do so is to include this line in the ZCML:
``<include package='zope.app.apidoc' file='static.zcml' condition='have static-apidoc' />``.
See `PR #13
<https://github.com/zopefoundation/zope.app.apidoc/pull/13/>`_.
- Class Finder entries in live apidoc are now displayed on separate lines, like in static exports.
See `PR #14 <https://github.com/zopefoundation/zope.app.apidoc/pull/14/>`_.
- Class Finder search in static exports will search on Enter, not just when clicking "Find".
See `PR #15 <https://github.com/zopefoundation/zope.app.apidoc/pull/15/>`_.
- ``__main__.py`` files are no longer imported by the code documentation module.
See `issue #22
<https://github.com/zopefoundation/zope.app.apidoc/issues/22>`_.
- Cython functions registered as adapters on Python 2 no longer break
page generation with an ``AttributeError``. See `issue 25
<https://github.com/zopefoundation/zope.app.apidoc/issues/25>`_.
- Static exports no longer highlight lines in ZCML files. See `issue #24
<https://github.com/zopefoundation/zope.app.apidoc/issues/24>`_.
4.0.0 (2017-05-25)
==================
- Add support for Python 3.4, 3.5, 3.6 and PyPy.
- The long-deprecated layer configuration was removed. It was only
ever available if the ``deprecatedlayers`` ZCML feature was installed.
- Modernize some of the templates. ``zope.app.apidoc`` can now be used
with Chameleon 3.2 via z3c.pt and z3c.ptcompat.
- Declared install dependency on ``zope.app.exception``.
- Docstrings are treated as UTF-8 on Python 2.
- Handle keyword only arguments and annotations in function signatures
on Python 3.
- Change the default documentation format to ``restructuredtext`` for
modules that do not specify a ``__docformat__``. Previously it was
``structuredtext`` (STX).
3.7.5 (2010-09-12)
==================
- Define ``__file__`` in doctests to make them pass under Python 2.4.
3.7.4 (2010-09-01)
==================
- Prefer the standard library's doctest module to the one from zope.testing.
- Remove unneeded dependencies zope.app.component and zope.app.container
3.7.3 (2010-07-14)
==================
- Apply refactoring from #153309.
- Fix LP bug 605057: ZCML links were no longer working (Guilherme Salgado)
3.7.2 (2010-03-07)
==================
- Adapted tests for Python2.4
3.7.1 (2010-01-05)
==================
- Updated tests to work with zope.publisher 3.12 (using ``zope.login``).
3.7.0 (2009-12-22)
==================
- Updated tests to work with latest ``zope.testing`` and use ``zope.browserpage`` in
favor of ``zope.app.pagetemplate``.
3.6.8 (2009-11-18)
==================
- Updated the tests after moving ``IPossibleSite`` and ``ISite`` to
``zope.component``.
3.6.7 (2009-09-29)
==================
- Updated the tests after moving ``ITraverser`` back to ``zope.traversing``.
3.6.6 (2009-09-15)
==================
- Made the tests work again with the most recent Zope Toolkit KGS.
3.6.5 (2009-07-24)
==================
- Update documentation file in ``zope.site`` from ``README.txt`` to
``site.txt``.
3.6.4 (2009-07-23)
==================
- The ``IContained`` interface moved to ``zope.location.interfaces``. Make a
test pass.
3.6.3 (2009-05-16)
==================
- Explicitly defined default views.
- Replace relative url links with absolute ones.
- Added ``z3c`` packages to the code browser.
- Made ``bin/static-apidoc`` principally working (publisher and
webserver mode). There are still some files which are not correctly
fetched.
3.6.2 (2009-03-17)
==================
- Adapt principal registry book chapter to a new place, as it was moved
from zope.app.security to zope.principalregistry.
- Remove zcml slugs and old zpkg-related files.
3.6.1 (2009-02-04)
==================
- When a module provides an interface or has an __all__ attribute,
use one of those for the module documentation. Fixes LP #323375.
- Undid broken link to ``savepoint.txt`` caused in 3.6.0. The latest
version of the transaction package puts savepoint.txt in the ``tests``
subpackage.
- Expanded the presentation of module documentation.
- Class documentation now includes constructor information.
3.6.0 (2009-01-31)
==================
- Use zope.container instead of zope.app.container.
- Use zope.site instead of zope.app.component and zope.app.folder (in
at least a few places).
- ``savepoint.txt`` moved from ZODB's test directory a level up -- we
follow.
- Make compatible with new zope.traversing and zope.location.
3.5.0 (2009-01-17)
==================
- Adapted transaction book chapters for new transaction egg. The
README.txt was removed and savepoint.txt was moved. Also add chapter
about dooming transactions (doom.txt).
- Changed mailing list address to zope-dev at zope.org, because zope3-dev
is retired now.
- Cleaned up dependencies.
3.4.3 (2007-11-10)
==================
- Fix https://bugs.launchpad.net/zope3/+bug/161737: Misleading text in
the interface viewer.
- Fix https://bugs.launchpad.net/zope3/+bug/161190: The zope3-dev
mailinglist has been retired, point to zope-dev.
3.4.2 (2007-10-30)
==================
- Avoid deprecation warnings for ``ZopeMessageFactory``.
3.4.1 (2007-10-23)
==================
- Avoid deprecation warnings.
3.4.0 (2007-10-10)
==================
- Improved package meta-data.
- Fixed the code to at least gracefully ignore unzipped eggs. Eventually we
want to handle eggs well.
3.4.0a1 (2007-04-22)
====================
- Initial release independent of the main Zope tree.
Raw data
{
"_id": null,
"home_page": "http://github.com/zopefoundation/zope.app.apidoc",
"name": "zope.app.apidoc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "zope3 api documentation",
"author": "Zope Corporation and Contributors",
"author_email": "zope-dev@zope.org",
"download_url": "https://files.pythonhosted.org/packages/51/86/0dbf89720dbfc65f9088ece51bd77e4134db3088a550da3e2f325e5d335a/zope.app.apidoc-5.0.tar.gz",
"platform": null,
"description": ".. image:: https://readthedocs.org/projects/zopeappapidoc/badge/?version=latest\n :target: https://zopeappapidoc.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://github.com/zopefoundation/zope.app.apidoc/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/zopefoundation/zope.app.apidoc/actions/workflows/tests.yml\n :alt: Build Status\n\n.. image:: https://coveralls.io/repos/github/zopefoundation/zope.app.apidoc/badge.svg?branch=master\n :target: https://coveralls.io/github/zopefoundation/zope.app.apidoc?branch=master\n :alt: Code Coverage\n\nThis Zope 3 package provides fully dynamic API documentation of Zope 3 and\nregistered add-on components. The package is very extensible and can be easily\nextended by implementing new modules.\n\nDocumentation is available at https://zopeappapidoc.readthedocs.io/\n\n\n=========\n CHANGES\n=========\n\n5.0 (2023-07-06)\n================\n\n- Drop support for Python 2.7, 3.5, 3.6.\n\n- Add support for Python 3.11.\n\n\n4.3.0 (2021-12-15)\n==================\n\n- Add support for Python 3.8, 3.9 and 3.10.\n\n- Drop support for Python 3.4.\n\n\n4.2.0 (2018-08-21)\n==================\n\n- Add support for Python 3.7.\n\n- The root ``Code`` documentation node no longer allows incidental\n traversal and documentation of unregistered root modules such as\n ``re`` and ``logging`` (``builtins`` is special cased). These were\n not listed in the tables of contents or menus, and mostly served to\n slow down static exports. To document a root module, explicitly\n include it in ZCML with ``<apidoc:rootModule module=\"MODULE\" />``.\n See `issue #20\n <https://github.com/zopefoundation/zope.app.apidoc/issues/20>`_.\n\n- Fix ``codemodule.Module`` for modules that have a ``__file__`` of\n ``None``. This can be the case with namespace packages, especially\n under Python 3.7. See `issue #17 <https://github.com/zopefoundation/zope.app.apidoc/issues/17>`_.\n\n- Rendering documentation for a class that has a ``__doc__`` property\n no longer fails but produces a descriptive message. See `issue 16\n <https://github.com/zopefoundation/zope.app.apidoc/issues/16>`_.\n\n- Host documentation at https://zopeappapidoc.readthedocs.io/\n\n- Add argument to ``static-apidoc`` for loading a specific ZCML file. To use this feature, the ZCML file you specify needs to\n establish a working Zope 3 publication environment. The easiest way to do so is to include this line in the ZCML:\n ``<include package='zope.app.apidoc' file='static.zcml' condition='have static-apidoc' />``.\n See `PR #13\n <https://github.com/zopefoundation/zope.app.apidoc/pull/13/>`_.\n\n- Class Finder entries in live apidoc are now displayed on separate lines, like in static exports.\n See `PR #14 <https://github.com/zopefoundation/zope.app.apidoc/pull/14/>`_.\n\n- Class Finder search in static exports will search on Enter, not just when clicking \"Find\".\n See `PR #15 <https://github.com/zopefoundation/zope.app.apidoc/pull/15/>`_.\n\n- ``__main__.py`` files are no longer imported by the code documentation module.\n See `issue #22\n <https://github.com/zopefoundation/zope.app.apidoc/issues/22>`_.\n\n- Cython functions registered as adapters on Python 2 no longer break\n page generation with an ``AttributeError``. See `issue 25\n <https://github.com/zopefoundation/zope.app.apidoc/issues/25>`_.\n\n- Static exports no longer highlight lines in ZCML files. See `issue #24 \n <https://github.com/zopefoundation/zope.app.apidoc/issues/24>`_.\n\n4.0.0 (2017-05-25)\n==================\n\n- Add support for Python 3.4, 3.5, 3.6 and PyPy.\n\n- The long-deprecated layer configuration was removed. It was only\n ever available if the ``deprecatedlayers`` ZCML feature was installed.\n\n- Modernize some of the templates. ``zope.app.apidoc`` can now be used\n with Chameleon 3.2 via z3c.pt and z3c.ptcompat.\n\n- Declared install dependency on ``zope.app.exception``.\n\n- Docstrings are treated as UTF-8 on Python 2.\n\n- Handle keyword only arguments and annotations in function signatures\n on Python 3.\n\n- Change the default documentation format to ``restructuredtext`` for\n modules that do not specify a ``__docformat__``. Previously it was\n ``structuredtext`` (STX).\n\n3.7.5 (2010-09-12)\n==================\n\n- Define ``__file__`` in doctests to make them pass under Python 2.4.\n\n3.7.4 (2010-09-01)\n==================\n\n- Prefer the standard library's doctest module to the one from zope.testing.\n\n- Remove unneeded dependencies zope.app.component and zope.app.container\n\n3.7.3 (2010-07-14)\n==================\n\n- Apply refactoring from #153309.\n- Fix LP bug 605057: ZCML links were no longer working (Guilherme Salgado)\n\n3.7.2 (2010-03-07)\n==================\n\n- Adapted tests for Python2.4\n\n\n3.7.1 (2010-01-05)\n==================\n\n- Updated tests to work with zope.publisher 3.12 (using ``zope.login``).\n\n3.7.0 (2009-12-22)\n==================\n\n- Updated tests to work with latest ``zope.testing`` and use ``zope.browserpage`` in\n favor of ``zope.app.pagetemplate``.\n\n3.6.8 (2009-11-18)\n==================\n\n- Updated the tests after moving ``IPossibleSite`` and ``ISite`` to\n ``zope.component``.\n\n3.6.7 (2009-09-29)\n==================\n\n- Updated the tests after moving ``ITraverser`` back to ``zope.traversing``.\n\n3.6.6 (2009-09-15)\n==================\n\n- Made the tests work again with the most recent Zope Toolkit KGS.\n\n3.6.5 (2009-07-24)\n==================\n\n- Update documentation file in ``zope.site`` from ``README.txt`` to\n ``site.txt``.\n\n3.6.4 (2009-07-23)\n==================\n\n- The ``IContained`` interface moved to ``zope.location.interfaces``. Make a\n test pass.\n\n3.6.3 (2009-05-16)\n==================\n\n- Explicitly defined default views.\n\n- Replace relative url links with absolute ones.\n\n- Added ``z3c`` packages to the code browser.\n\n- Made ``bin/static-apidoc`` principally working (publisher and\n webserver mode). There are still some files which are not correctly\n fetched.\n\n3.6.2 (2009-03-17)\n==================\n\n- Adapt principal registry book chapter to a new place, as it was moved\n from zope.app.security to zope.principalregistry.\n\n- Remove zcml slugs and old zpkg-related files.\n\n3.6.1 (2009-02-04)\n==================\n\n- When a module provides an interface or has an __all__ attribute,\n use one of those for the module documentation. Fixes LP #323375.\n\n- Undid broken link to ``savepoint.txt`` caused in 3.6.0. The latest\n version of the transaction package puts savepoint.txt in the ``tests``\n subpackage.\n\n- Expanded the presentation of module documentation.\n\n- Class documentation now includes constructor information.\n\n3.6.0 (2009-01-31)\n==================\n\n- Use zope.container instead of zope.app.container.\n\n- Use zope.site instead of zope.app.component and zope.app.folder (in\n at least a few places).\n\n- ``savepoint.txt`` moved from ZODB's test directory a level up -- we\n follow.\n\n- Make compatible with new zope.traversing and zope.location.\n\n3.5.0 (2009-01-17)\n==================\n\n- Adapted transaction book chapters for new transaction egg. The\n README.txt was removed and savepoint.txt was moved. Also add chapter\n about dooming transactions (doom.txt).\n\n- Changed mailing list address to zope-dev at zope.org, because zope3-dev\n is retired now.\n\n- Cleaned up dependencies.\n\n3.4.3 (2007-11-10)\n==================\n\n- Fix https://bugs.launchpad.net/zope3/+bug/161737: Misleading text in\n the interface viewer.\n\n- Fix https://bugs.launchpad.net/zope3/+bug/161190: The zope3-dev\n mailinglist has been retired, point to zope-dev.\n\n\n3.4.2 (2007-10-30)\n==================\n\n- Avoid deprecation warnings for ``ZopeMessageFactory``.\n\n3.4.1 (2007-10-23)\n==================\n\n- Avoid deprecation warnings.\n\n3.4.0 (2007-10-10)\n==================\n\n- Improved package meta-data.\n\n- Fixed the code to at least gracefully ignore unzipped eggs. Eventually we\n want to handle eggs well.\n\n3.4.0a1 (2007-04-22)\n====================\n\n- Initial release independent of the main Zope tree.\n",
"bugtrack_url": null,
"license": "ZPL 2.1",
"summary": "API Documentation and Component Inspection for Zope 3",
"version": "5.0",
"project_urls": {
"Homepage": "http://github.com/zopefoundation/zope.app.apidoc"
},
"split_keywords": [
"zope3",
"api",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3b14c1723e40a4ac0d57fefcd359f674407af590ed614bd7bcec71a1557b8e3f",
"md5": "183bbe43f25668b6ecf30458a61a71f6",
"sha256": "3133696a4db8b51f97839b442c05e486acdda4092ddf250d180d98eb5cf82731"
},
"downloads": -1,
"filename": "zope.app.apidoc-5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "183bbe43f25668b6ecf30458a61a71f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 195430,
"upload_time": "2023-07-06T06:24:15",
"upload_time_iso_8601": "2023-07-06T06:24:15.313466Z",
"url": "https://files.pythonhosted.org/packages/3b/14/c1723e40a4ac0d57fefcd359f674407af590ed614bd7bcec71a1557b8e3f/zope.app.apidoc-5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51860dbf89720dbfc65f9088ece51bd77e4134db3088a550da3e2f325e5d335a",
"md5": "6994d8374f2185a97395858061f1ef18",
"sha256": "808288be72a51a60b0bbfeffe6cbc7e926d0e9807176c389ce0d12d3319ebaf8"
},
"downloads": -1,
"filename": "zope.app.apidoc-5.0.tar.gz",
"has_sig": false,
"md5_digest": "6994d8374f2185a97395858061f1ef18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 140511,
"upload_time": "2023-07-06T06:24:18",
"upload_time_iso_8601": "2023-07-06T06:24:18.186325Z",
"url": "https://files.pythonhosted.org/packages/51/86/0dbf89720dbfc65f9088ece51bd77e4134db3088a550da3e2f325e5d335a/zope.app.apidoc-5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-06 06:24:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "zopefoundation",
"github_project": "zope.app.apidoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "zope.app.apidoc"
}
JSON
