[Patches] [ python-Patches-1376361 ] Use 'seealso' to add examples to LibRef

[SourceForge.net]

Patches item #1376361, was opened at 2005-12-08 10:16
Message generated for change (Comment added) made by akuchling
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=1376361&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: Python 2.5
Status: Open
Resolution: None
Priority: 5
Submitted By: A.M. Kuchling (akuchling)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Use 'seealso' to add examples to LibRef

Initial Comment:
Fredrik Lundh suggested a simple markup to let people
publish examples on their own sites and have the
examples get linked into the Library Reference.  I
wrote a simple parser for the markup and checked it in
as sandbox/seealso. 

The attached patch adds a Makefile target, 'examples',
that downloads feeds listed in a file and generates a
directory of *.tex files that can be included.  The
patch also modifies one file, libzlib.tex, to include
the generated examples; all of the modules would need
to be modified.

The patch currently assumes that you've checked out the
sandbox in the same directory as your Python tree.  If
accepted, the seealso scripts would move into Doc/tools/.

The Makefile patch makes lib/ always trigger the
examples target.  Alternatively it could be left as a
separate target; as long as the release process
includes "make examples", it would be fine.  (I can't
figure out the shell-script hackery to only update the
examples  every 24 hours.  The Python scripts could be
modified to do this.)

Running "make examples" requires a file called
Doc/example-feeds.  Currently my copy contains a single
line: 'file:../../sandbox/seealso/seealso.xml'.




----------------------------------------------------------------------

>Comment By: A.M. Kuchling (akuchling)
Date: 2005-12-09 14:22

Message:
Logged In: YES 
user_id=11375

LaTeX supports \InputIfFileExists{examples/zlib.tex}{}{}.

LaTeX2HTML chokes on \InputIfFileExists, however; some
hackery will be required.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=305470&aid=1376361&group_id=5470