Opened 6 years ago

Closed 6 years ago

#3069 enhancement closed fixed (fixed)

Automated support for generating API documentation

Reported by: exarkun Owned by:
Priority: normal Milestone: totally automated release infrastructure
Component: release management Keywords:
Cc: Branch: branches/api-builder-3069-3
(diff, github, buildbot, log)
Author: exarkun Launchpad Bug:

Description

Create a kind of builder in twisted.python._release which emits pydoctor-generated API docs.

Change History (14)

comment:1 Changed 6 years ago by exarkun

  • author set to exarkun
  • Branch set to branches/api-builder-3069

(In [22778]) Branching to 'api-builder-3069'

comment:2 Changed 6 years ago by exarkun

  • Branch changed from branches/api-builder-3069 to branches/api-builder-3069-2

(In [22806]) Branching to 'api-builder-3069-2'

comment:3 Changed 6 years ago by radix

  • Milestone set to twisted-8.0

comment:4 Changed 6 years ago by therve

  • Keywords review added

comment:5 Changed 6 years ago by therve

  • Keywords review removed
  • please pass the '--quiet' option to pydoctor
  • test should be skipped if pydoctor is not importable

comment:6 Changed 6 years ago by radix

  • Milestone changed from twisted-8.0 to regular-releases

comment:7 Changed 6 years ago by exarkun

  • Branch changed from branches/api-builder-3069-2 to branches/api-builder-3069-3

(In [23145]) Branching to 'api-builder-3069-3'

comment:8 Changed 6 years ago by exarkun

  • Keywords review added
  • Owner exarkun deleted

Done. Note this still requires a branch of pydoctor, it won't work with trunk (that was true last time too but since I didn't mention it before...).

comment:9 Changed 6 years ago by therve

  • Keywords review removed
  • Owner set to exarkun

OK, I have finally found what was wrong: you're not passing the system-class option. That explains why the private members are generated with the APIBuilder class.

comment:10 Changed 6 years ago by exarkun

  • Keywords review added
  • Owner exarkun deleted

That's a pretty important thing I guess! Thanks. The code specifies a system class now.

comment:11 Changed 6 years ago by therve

  • Component changed from core to release management
  • Keywords review removed
  • Owner set to exarkun

Please merge!

comment:12 Changed 6 years ago by therve

For some reasons, the 2.3 builder tries to import pydoctor but then fails: http://buildbot.twistedmatrix.com/builders/debian-py2.3-select/builds/2582/steps/trial/logs/problems. We probably want to fix the slave.

comment:13 Changed 6 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [23166]) Merge api-builder-3069-3

Author: exarkun, itamarst
Reviewer: therve
Fixes #3069

Add a release automation class for generating API documentation
using pydoctor.

comment:14 Changed 4 years ago by <automation>

  • Owner exarkun deleted
Note: See TracTickets for help on using tickets.