./devel/py-doctor, Python API document generator

[ CVSweb ] [ Homepage ] [ RSS ] [ Required by ] [ Add to tracker ]


Branch: CURRENT, Version: 24.3.3, Package name: py312-doctor-24.3.3, Maintainer: kamelderouiche

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 at this stage :)

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.


Required to run:
[net/py-twisted] [devel/py-setuptools] [devel/epydoc] [lang/python27]

Required to build:
[pkgtools/cwrappers]

Master sites:

Filesize: 914.544 KB

Version history: (Expand)


CVS history: (Expand)


   2023-12-04 07:08:54 by Adam Ciarcinski | Files touched by this commit (1)
Log message:
py-doctor: add TOOL_DEPENDS
   2023-12-04 07:07:50 by Adam Ciarcinski | Files touched by this commit (4) | Package updated
Log message:
py-doctor: updated to 23.9.1

pydoctor 23.9.1

Fix regression in link not found warnings' line numbers.

pydoctor 23.9.0

This is the last major release to support Python 3.6.

Do not show **kwargs when keywords are specifically documented with the keyword \ 
field and no specific documentation is given for the **kwargs entry.
Fix annotation resolution edge cases: names are resolved in the context of the \ 
module scope when possible, when impossible, the theoretical runtime scopes are \ 
used. A warning can be reported when an annotation name is ambiguous (can be \ 
resolved to different names depending on the scope context) with option -v.
Ensure that explicit annotation are honored when there are multiple declarations \ 
of the same name.
Use stricter verification before marking an attribute as constant:
instance variables are never marked as constant
a variable that has several definitions will not be marked as constant
a variable declaration under any kind of control flow block will not be marked \ 
as constant
Do not trigger warnings when pydoctor cannot make sense of a potential constant \ 
attribute (pydoctor is not a static checker).
Fix presentation of type aliases in string form.
Improve the AST colorizer to output less parenthesis when it's not required.
Fix colorization of dictionary unpacking.
Improve the class hierarchy such that it links top level names with intersphinx \ 
when possible.
Add highlighting when clicking on "View In Hierarchy" link from class page.
Recognize variadic generics type variables (PEP 646).
Fix support for introspection of cython3 generated modules.
Instance variables are marked as such across subclasses.
   2023-08-12 02:31:02 by David H. Gutteridge | Files touched by this commit (1)
Log message:
py-doctor: restore not for Python 3.8 setting (fix bulk builds)

This is marked not for 3.8 because py-lunr is, which in turn is because
py-nltk is, which is in turn evidently because py-numpy is (though,
there it is only a TEST_DEPENDS).
   2023-08-11 15:01:29 by Adam Ciarcinski | Files touched by this commit (3) | Package updated
Log message:
py-doctor: updated to 23.4.1

pydoctor 23.4.1

Pin urllib3 version to keep compatibility with cachecontrol and python3.6.

pydoctor 23.4.0

Add support for Python 3.11
Add support for the @overload decorator.
Show type annotations in function's signatures.
If none of a function's parameters have documentation, do not render the \ 
parameter table.
Themes have been adjusted to render annotations more concisely.
Fix a rare crash in the type inference. Invalid python code like a set of lists \ 
would raise a uncaught TypeError in the evaluation.
Support when source path lies outside base directory (--project-base-dir). Since \ 
pydoctor support generating docs for multiple packages, it is not certain that \ 
all of the source is even viewable below a single URL. We now allow to add \ 
arbitrary paths to the system, but only the objects inside a module wich path is \ 
relative to the base directory can have a source control link generated.
Cache the default docutils settings on docutils>=0.19 to improve performance.
Improve the search bar user experience by automatically appending wildcard to \ 
each query terms when no terms already contain a wildcard.
Link recognized constructors in class page.
An invalid epytext docstring will be rederered as plaintext, just like invalid \ 
restructuredtext docstrings (finally).
   2023-07-30 17:32:50 by Adam Ciarcinski | Files touched by this commit (19)
Log message:
Remove dependencies for Python 3.7
   2023-07-01 10:37:47 by Thomas Klausner | Files touched by this commit (105) | Package updated
Log message:
*: restrict py-numpy users to 3.9+ in preparation for update
   2023-03-29 11:34:15 by Thomas Klausner | Files touched by this commit (96)
Log message:
*: use PYTHON_VERSION instead of _PYTHON_VERSION
   2022-11-29 18:13:22 by Adam Ciarcinski | Files touched by this commit (2) | Package updated
Log message:
py-doctor: updated to 22.9.1

pydoctor 22.9.1

pydoctor --help works again.

pydoctor 22.9.0

Add a special kind for exceptions (before, they were treated just like any other \ 
class).
The ZopeInterface features now renders again. A regression was introduced in \ 
pydoctor 22.7.0.
Python syntax errors are now logged as violations.
Fixed rare crash in the rendering of parsed elements (i.e. docstrings and ASTs). \ 
This is because XHTML entities like non-breaking spaces are not supported by \ 
Twisted's XMLString at the moment.
Show the value of type aliases and type variables.
The --prepend-package now work as documented. A regression was introduced in \ 
pydoctor 22.7.0 and it was not nesting new packages under the "fake" \ 
package.
self parameter is now removed only when the target is a method. In the previous \ 
version, it was always removed in any context.
cls parameter is now removed only when the target is a class method. In the \ 
previous version, it was always removed in any context.
Add anchors aside attributes and functions to ease the process of sharing links \ 
to these API docs.
Fix a bug in the return clause of google-style docstrings where the return type \ 
would be treated as the description when there is no explicit description.
Trigger warnings for unknown config options.
Fix minor UX issues in the search bar.
Fix deprecation in Docutils 0.19 frontend