Skip to content

Commit

Permalink
Outline diff to sphinx in context of automation level (#791)
Browse files Browse the repository at this point in the history
  • Loading branch information
buhtz committed May 7, 2024
1 parent 79f4dc9 commit 332f67b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ It also has support for `zope.interface <https://zopeinterface.readthedocs.io/en

How is it different from ``sphinx-autodoc``
-------------------------------------------

``sphinx-autodoc`` can be complex and the output is sometimes overwhelming, ``pydoctor`` will generate
``sphinx-autodoc`` operates semi-automatic rather than fully automatically. It can not generate documentation solely from Python source files; it always requires a reStructuredText file as well.
It can also be complex and the output is sometimes overwhelming, ``pydoctor`` will generate
one page per class, module and package, it tries to keeps it simple and present information in a efficient way with tables.

Sphinx narrative documentation can seamlessly link to API documentation formatted by pydoctor.
Expand Down

0 comments on commit 332f67b

Please sign in to comment.