a question about documentation
Hello, could someone let me know about how was mailman-install.pdf manual generated? CC to me... K.
Kārlis Repsons wrote:
Hello, could someone let me know about how was mailman-install.pdf manual generated? CC to me...
All the pdfs are generated from LaTeX files (.tex) that can be found in the source tree under... uh.. probably doc/ or maybe admin/doc. Look for mailman-install.tex. There may be a makefile there too, otherwise you can use latex to generate a pdf (texi2pdf or latex --output=pdf depending on your installation)
That said, I'm trying to keep the most recent documents in the wiki now, with the plan to eventually phase out the latex, so you may wish to use the wiki as the source in the future.
Terri
On Jun 2, 2009, at 12:51 AM, Terri Oda wrote:
That said, I'm trying to keep the most recent documents in the wiki
now, with the plan to eventually phase out the latex, so you may
wish to use the wiki as the source in the future.
This is a great plan, thanks Terri. Note that wiki pages can be
turned into PDF, IIRC. Any text based file system documentation we
include going forward should probably be in restructured text (reST)
format, since there are now excellent toolchains available to turn
this into good printed and online documentation (Sphinx). I think we
can now claim reST is the standard documentation format for Python
code. All of MM3's doctests are in reST for example.
-Barry
Terri Oda wrote:
All the pdfs are generated from LaTeX files (.tex) that can be found in the source tree under... uh.. probably doc/ or maybe admin/doc.
Just a technical note - the .tex files haven't been included in the last few Mailman releases. The entire documentation package is available at <https://code.launchpad.net/~mailman-administrivia/mailman-administrivia/admin>.
-- Mark Sapiro <mark@msapiro.net> The highway is for gamblers, San Francisco Bay Area, California better use your sense - B. Dylan
participants (4)
-
Barry Warsaw -
Kārlis Repsons -
Mark Sapiro -
Terri Oda