Opened 9 years ago

Last modified 8 years ago

#28 new enhancement

specdomain: Add option to create separate developer and user versions of the documentation

Reported by: cschlep Owned by: jemian
Priority: critical Milestone: APS 2014-2
Keywords: specdomain Cc: jemian

Description (last modified by cschlep)

It would be good to produce separate developer and user versions of the documentation. The user version would only include the public definitions, while the developers could see all the definitions (private, hidden, and public), along with all the variable declarations, etc.

Is there a directive that we can use inside the code documentation to mark individual sections (determined by indentation) as "developer only", and they get ignored in the non-developer version? Something like the already defined .. only:: directive:

.. only:: developer

where the "developer" tag could be specified during the make process?

Change History (5)

comment:1 Changed 9 years ago by cschlep

  • Description modified (diff)

comment:2 Changed 9 years ago by cschlep

  • Description modified (diff)

comment:3 Changed 8 years ago by cschlep

  • Cc jemian added
  • Priority changed from minor to critical

comment:4 Changed 8 years ago by jemian

  • Milestone set to APS 2013-3

comment:5 Changed 8 years ago by jemian

  • Milestone changed from APS 2013-3 to APS 2014-2
Note: See TracTickets for help on using tickets.