Opened 3 years ago

Closed 3 years ago

#8512 enhancement closed duplicate (duplicate)

Build apidoc in Travis-CI

Reported by: Adi Roiban Owned by: Adi Roiban
Priority: normal Milestone:
Component: core Keywords:
Cc: Branch: 8512-travis-apidocs
branch-diff, diff-cov, branch-cov, buildbot


it should be expected to fail, but in this way external contributors can check their errors.

also if contributors want to help with cleaning the apidocs from errors, this build can come in handy...

but I hope that contributors are able to execute the apidocs on their local machine

still, this is useful so that we can prepare for having apidocs as part of the full build on travis-ci... once all errors are cleared

Change History (4)

comment:1 Changed 3 years ago by Adi Roiban

Branch: 8512-travis-apidocs

comment:2 Changed 3 years ago by Adi Roiban

Keywords: review added
Owner: Adi Roiban deleted

In #8565 all pydoctor errors were fixes so now the api-docs builder runs without errors.

with that, we can include it in the travis build so that non-team member contributors will be warned if the api documentation is broken.

Please check that changes make sense.


comment:3 Changed 3 years ago by Craig Rodrigues

Keywords: review removed
Owner: set to Adi Roiban

Looks OK.

comment:4 Changed 3 years ago by Adi Roiban

Resolution: duplicate
Status: newclosed

Thanks for the review.

Amber fixed this as a drive by of her branch in which the api doc builder code was also fixed.

Note: See TracTickets for help on using tickets.