Ticket #2166 (closed task: fixed)

Opened 2 years ago

Last modified 3 months ago

Make running the doc parser part of the build process

Reported by: owen Owned by: pottedmeat
Priority: normal Milestone: 1.2
Component: General Version: 0.4.1
Severity: normal Keywords:
Cc:

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

Changed 2 years ago by 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

Changed 22 months ago by dylan

  • milestone set to 0.9

Changed 16 months ago by dante

  • milestone changed from 0.9 to 1.0

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

Changed 13 months ago by peller

  • owner changed from dmachi to pottedmeat
  • milestone deleted

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!

Changed 12 months ago by dante

  • milestone set to 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.

Changed 3 months ago by dante

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

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.