pax_global_header00006660000000000000000000000064127660240650014522gustar00rootroot0000000000000052 comment=3031eec8cb01697c22d496a02c9888dfe3a9b701 pydoctor-16.3.0/000077500000000000000000000000001276602406500134545ustar00rootroot00000000000000pydoctor-16.3.0/.gitignore000066400000000000000000000000671276602406500154470ustar00rootroot00000000000000build MANIFEST dist *.pyc .tox/ .coverage .DS_Store *~ pydoctor-16.3.0/.travis.yml000066400000000000000000000023041276602406500155640ustar00rootroot00000000000000language: python matrix: include: - python: 2.7 env: TOX_ENV=pyflakes - python: pypy env: TOX_ENV=test-pypy - python: 2.7 env: TOX_ENV=test-py27-codecov-travis - python: 2.7 env: TOX_ENV=twisted-apidoc allow_failures: # Twisted trunk is broken for now. - env: TOX_ENV=twisted-apidoc install: - pip install tox script: tox -e $TOX_ENV notifications: email: false # Do an automatic PyPi release when a tag is created. # http://docs.travis-ci.com/user/deployment/pypi/ # Make sure builds are triggered for any push so that the tag push will also # trigger a build. deploy: provider: pypi # twistedchecker-robot is associated with adi.roiban email address from # Gmail. It uses a random password which was not recorded in plain text. user: twistedchecker-robot password: secure: D8Jlbsm8sN1Nz11SgFI7HRxjx0/gLDl66RB101nrhP4Bs4tzK2s9duu7P6nGRIupX5r5czRpSyhPrPQjci3UhcxZf5OTTCd5pamGBd7dv32Usr2aXWhvIfulX+i7jtbOBiWQT7JhxjSjlvyZLW0kka3eClQaD+D4iI64zaBn7y0= on: tags: true # All branches is still required. # https://github.com/travis-ci/travis-ci/issues/1675 all_branches: true condition: "$TOX_ENV = test-py27-codecov-travis" pydoctor-16.3.0/LICENSE.txt000066400000000000000000000015171276602406500153030ustar00rootroot00000000000000 Copyright 2006-2008 Michael Hudson mwh@python.net All Rights Reserved Permission to use, copy, modify, and distribute this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. THE AUTHOR MICHAEL HUDSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. pydoctor-16.3.0/MANIFEST.in000066400000000000000000000001771276602406500152170ustar00rootroot00000000000000include setup.cfg graft pydoctor/templates graft doc include *.txt *.tac include MANIFEST.in include *.cfg graft pydoctor/test pydoctor-16.3.0/README.rst000066400000000000000000000044571276602406500151550ustar00rootroot00000000000000pydoctor ======== .. 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 it happens to work for your code too, that's a nice bonus :) 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. The default HTML generator requires Twisted. There are some more notes in the doc/ subdirectory. Tox development environment --------------------------- Since Python 3 is not yet supported, you the case in which your default tox runs with Python 3, call the tox as:: python2 -m tox -e pyflakes Sphinx Integration ------------------ 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: Configure Sphinx intersphinx extension: intersphinx_mapping = { 'pydoctor': ('http://domain.tld/api', None), } Use external references:: :py:func:`External API ` :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` It can link to external API documentation using Sphinx objects inventory using the following cumulative configuration option:: --intersphinx=http://sphinx-doc.org/objects.inv Releasing a new package ----------------------- Releasing a new version is done via Travis-CI. First commit the version update to master and wait for tests to pass. Create a tag on local branch and then push it:: git tag 1.2.3 git push --tags pydoctor-16.3.0/apilinks_sphinxext.py000066400000000000000000000025211276602406500177520ustar00rootroot00000000000000""" Sphinx/docutils extension to create links to pyDoctor documentation using a RestructuredText interpreted text role that looks like this:: :api:`python_object_to_link_to