Ticket #3069 enhancement closed fixed

Opened 5 years ago

Last modified 5 years ago

Automated support for generating API documentation

Reported by: exarkun Owned by:
Priority: normal Milestone: regular-releases
Component: release management Keywords:
Cc: Branch: branches/api-builder-3069-3
Author: exarkun Launchpad Bug:

Description

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

Change History

1

Changed 5 years ago by exarkun

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

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

2

Changed 5 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'

3

Changed 5 years ago by radix

  • milestone set to twisted-8.0

4

Changed 5 years ago by therve

  • keywords review added

5

Changed 5 years ago by therve

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

6

Changed 5 years ago by radix

  • milestone changed from twisted-8.0 to regular-releases

7

Changed 5 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'

8

Changed 5 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...).

9

Changed 5 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.

10

Changed 5 years ago by exarkun

  • owner exarkun deleted
  • keywords review added

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

11

Changed 5 years ago by therve

  • owner set to exarkun
  • keywords review removed
  • component changed from core to release management

Please merge!

12

Changed 5 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.

13

Changed 5 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

(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.

14

Changed 2 years ago by <automation>

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