[Doc-SIG] Global Module Index

[Fred L. Drake]

Christopher G. Petrilli writes:
 > I wonder if it's possible to notate "platform specific" modules in
 > italics or something?  Just so people don't go looking for them if they

  That would be nice.  There's nothing in the documentation now that
allows that information to be extracted; placement within a chapter is 
the only source of that information, making it essentially human-
only.
  I think explicit markup of the information would be the most
appropriate way to deal with this.  Perhaps the \declaremodule could
optionally be followed by a \platform macro that accepted a comma-
separated list of platforms (sys.platform values) as a parameter.  If
\platform isn't specified, the module would be considered portable.
  The macro probably shouldn't generate any text, but could be used to 
produce information in an auxilliary file and the index.  That
auxilliary file could be used when generating other documentation
items.

 > Also, how 'bout a link to this from the main doc page, I miss that :-)

  That's comes with the general announcement.


  -Fred

--
Fred L. Drake, Jr.	     <fdrake@acm.org>
Corporation for National Research Initiatives
1895 Preston White Dr.	    Reston, VA  20191