[Python-apps-team] Bug#932584: Epydoc and Pydoctor

[Kenneth Pronovici]

On Wed, Jul 31, 2019 at 10:46 AM Ian Jackson
<ijackson at chiark.greenend.org.uk> wrote:
> > Otherwise, I will see if I can determine how well the package works
> > without epydoc installed.  If it works (i.e. doesn't blow up) and I
> > don't hear back with other instructions, I will eventually NMU my
> > changes to remove the epydoc dependency.   Given that I haven't gotten
> > any replies for more than 18 months now, I won't wait that long before
> > doing this NMU.
>
> That sounds really good to me for now.  I think you can do this NMU
> whenever you like.

I tested pydoctor against my own cedar-backup2 code, which I never converted
away from Epydoc since it's Python 2-only.   It seems to work fine:

mars:~/projects/dev/software/cedar-backup2> pydoctor CedarBackup2/
adding directory /home/pronovic/projects/dev/software/cedar-backup2/CedarBackup2
41/41 modules processed 0 warnings
WARNING: guessing CedarBackup2 for project name
writing html to apidocs using pydoctor.templatewriter.writer.TemplateWriter
starting ModuleIndexPage ...
Error trying to import 'epytext' parser:

    ImportError: No module named epydoc.markup.epytext

Using plain text formatting only.
took 0.006452s
starting ClassIndexPage ... took 0.011512s
starting IndexPage ... took 0.002281s
starting NameIndexPage ... took 0.079562s
starting UndocumentedSummaryPage ... took 0.004314s
125/125 pages written
Generating objects inventory at apidocs/objects.inv

The generated HTML documentation is legible, if not as pretty as it
would have been before.  Given that it works, I am going to NMU the
version of the package that doesn't depend on epydoc.  I'll also
create a PR on salsa.  On salsa, master has diverged from the released
package, but I am *not* going to integrate those changes, because I
don't want to take responsibility for them.

KEN

-- 
Kenneth J. Pronovici <pronovic at debian.org>