Zope.app.apidoc

================

- Nothing changed yet.

================

- Drop support for Python 2.7, 3.5, 3.6.

- Add support for Python 3.11.

==================

- Add support for Python 3.8, 3.9 and 3.10.

- Drop support for Python 3.4.

==================

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

==================

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

==================

- Define ``__file__`` in doctests to make them pass under Python 2.4.