Metadata-Version: 2.1
Name: pydoctor
Version: 20.7.1
Summary: API doc generator.
Home-page: https://github.com/twisted/pydoctor
Author: Michael Hudson-Doyle
Author-email: micahel@gmail.com
Maintainer: Maarten ter Huurne
Maintainer-email: maarten@boxingbeetle.com
License: MIT/X11
Project-URL: Issue Tracker, https://github.com/twisted/pydoctor/issues
Project-URL: Repository, https://github.com/twisted/pydoctor
Description: pydoctor
        ========
        
        .. image:: https://travis-ci.org/twisted/pydoctor.svg?branch=tox-travis-2
          :target: https://travis-ci.org/twisted/pydoctor
        
        .. image:: https://codecov.io/gh/twisted/pydoctor/branch/master/graph/badge.svg
          :target: https://codecov.io/gh/twisted/pydoctor
        
        This is *pydoctor*, an API documentation generator that works by
        static analysis.
        
        It was written primarily to replace epydoc for the purposes of the
        Twisted project as epydoc has difficulties with zope.interface.
        If you are looking for a successor to epydoc after moving to Python 3,
        pydoctor might be the right tool for your project as well.
        
        pydoctor puts a fair bit of effort into resolving imports and
        computing inheritance hierarchies and, as it aims at documenting
        Twisted, knows about zope.interface's declaration API and can present
        information about which classes implement which interface, and vice
        versa.
        
        .. contents:: Contents:
        
        
        Usage
        -----
        
        You can run pydoctor on your project like this::
        
            $ pydoctor --make-html --html-output=docs/api --add-package=src/mylib
        
        You can see the full list of options using ``pydoctor --help``.
        
        Markup
        ------
        
        pydoctor currently supports the following markup languages in docstrings:
        
        `epytext`__ (default)
            The markup language of epydoc.
            Simple and compact.
        
        `reStructuredText`__
            The markup language used by Sphinx.
            More expressive than epytext, but also slighly more complex and verbose.
        
        plain text
            Text without any markup.
        
        __ http://epydoc.sourceforge.net/manual-epytext.html
        __ https://docutils.sourceforge.io/rst.html
        
        You can select a different format using the ``--docformat`` option.
        
        Sphinx Integration
        ------------------
        
        Sphinx object inventories can be used to create deep links between API
        documentation generated by pydoctor and by Sphinx.
        
        Linking to external API docs
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        It can link to external API documentation using a Sphinx objects inventory
        with the following cumulative configuration option::
        
            --intersphinx=http://sphinx-doc.org/objects.inv
        
        Linking to your API docs
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        pydoctor's HTML generator will also generate a Sphinx objects inventory
        using the following mapping:
        
        * packages, modules -> py:mod:
        * classes -> py:class:
        * functions -> py:func:
        * methods -> py:meth:
        * attributes -> py:attr:
        
        To use this mapping in Sphinx, configure the `intersphinx extension`__::
        
            intersphinx_mapping = {
                'pydoctor': ('http://domain.tld/api', None),
            }
        
        __ https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
        
        And use external references::
        
            :py:func:`External API <pydoctor:pydoctor.model.Documentable.reparent>`
        
            :py:mod:`pydoctor:pydoctor`
            :py:mod:`pydoctor:pydoctor.model`
            :py:func:`pydoctor:pydoctor.driver.getparser`
            :py:class:`pydoctor:pydoctor.model.Documentable`
            :py:meth:`pydoctor:pydoctor.model.Documentable.reparent`
            :py:attr:`pydoctor:pydoctor.model.Documentable.kind`
        
        What's New?
        -----------
        
        pydoctor 20.7.0
        ~~~~~~~~~~~~~~~
        
        * Python 3 support
        * Type annotations on attributes are supported when running on Python 3
        * Type comments on attributes are supported when running on Python 3.8+
        * Type annotations on function definitions are not supported yet
        * Undocumented attributes are now included in the output
        * Attribute docstrings: a module, class or instance variable can be documented by a following it up with a docstring
        * Improved error reporting: more errors are reported, error messages include file name and line number
        * Dropped support for implicit relative imports
        * Explicit relative imports (using ``from``) no longer cause warnings
        * Dropped support for index terms in epytext (``X{}``); this was never supported in any meaningful capacity, but now the tag is gone
        
        This will be the last major release to support Python 2.7 and 3.5: future major releases will require Python 3.6 or later.
        
        pydoctor 20.7.1
        ~~~~~~~~~~~~~~~
        
        * Fix cross-reference links to builtin types in standard library
        * Fix and improve error message printed for unknown fields
        
        
Platform: UNKNOWN
Classifier: Development Status :: 6 - Mature
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Description-Content-Type: text/x-rst
