Opened 13 years ago

Closed 11 years ago

#2166 closed task (fixed)

Make running the doc parser part of the build process

Reported by: owen Owned by: Neil Roberts
Priority: high Milestone: 1.2
Component: General Version: 0.4.1
Keywords: Cc:
Blocked By: Blocking:

Description

On the nightlies, and the "cut" releases, we should run the doc parser before the code is posted. For the nightlies, it would be nice if the parser output was also checked back in so that folks getting the source will have a local copy of the api docs that are up to date.

Change History (6)

comment:1 Changed 13 years ago by Adam Peller

FWIW, I started by making a "docparser" target in the build.xml, but did not make "api" dependent upon it. I did not go so far as to make php5 part of the provided tools

comment:2 Changed 12 years ago by dylan

Milestone: 0.9

comment:3 Changed 12 years ago by dante

Milestone: 0.91.0

doesn't look like docparser will be ready in time. punt.

comment:4 Changed 12 years ago by Adam Peller

Milestone: 1.0
Owner: changed from Dustin Machi to Neil Roberts

Neil, is this valid in the new doc world now that the results no longer live in the source tree? Is there a strategy for dealing with multiple versions of docs? If so and there are instructions for dmachi to set up, please reassign and place a milestone back on this. Else, let's close this out. Thanks!

comment:5 Changed 12 years ago by dante

Milestone: 1.1

we're going to have to fix or close this by 1.1 and address the jsdoc issues sooner or later. I'm +1 nightly dumping an api.xml file again, but the route we seem to want to take is use jsdoc + drupal and export it somehow.

comment:6 Changed 11 years ago by dante

Resolution: fixed
Status: newclosed

So the api doc output is getting really large, and while it is a goal to have offline docs and a parse-able export-able file, it shouldn't live in the release. between that, api-staging handling versioning and the impending potential of cron running for HEAD, I think we can close this as "technically fixed"

Note: See TracTickets for help on using tickets.