Ticket #820 (closed todo: fixed)

Opened 5 years ago

Last modified 3 years ago

dynops should show up in docs/ops...

Reported by: coke Owned by:
Priority: normal Milestone:
Component: docs Version: trunk
Severity: medium Keywords:
Cc: Language:
Patch status: Platform:

Description

Now that (TT #449) oplibs in the dynoplibs are supposed to be more standard ops (rather than sample code), we need to generate .pod for them when running 'make docs'.

The generated pod for these can go in to the same dir as that of the non-dyn ops.

Attachments

dynopdocs.patch Download (1.3 KB) - added by dukeleto 5 years ago.
Attempt to fix the dynops issue. Close but not quite yet.

Change History

Changed 5 years ago by coke

  • milestone 1.4 deleted

Changed 5 years ago by dukeleto

What needs to happen to make this work?

Changed 5 years ago by coke

I'd start with 'make docs' and see how the POD from src/ops/*.ops ends up in doc/ops/*.ops.

I would just put them into the same directory, so that dynops/math.ops endsup as doc/ops/dyn_math.pod; alternatively, doc/dynops/math.pod;

Once that's done, check the 'make html' target to make sure they are copied in, and that the index shows them (so they're reachable from the main page.)

I haven't looked at the guts of those scripts in a while, so can't give more specific advice.

Changed 5 years ago by dukeleto

Changed 5 years ago by dukeleto

Attempt to fix the dynops issue. Close but not quite yet.

Changed 4 years ago by coke

  • owner set to coke

Changed 3 years ago by coke

  • owner coke deleted

Changed 3 years ago by cotto

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

After the make html rewrite, the dynop docs show up at the bottom of  file:///usr/src/parrot/parrot-git-master/docs/html/ops.html . I'm marking this as fixed.

Note: See TracTickets for help on using tickets.