Mailman 3 April 2006 - Doc-SIG

introducing the experimental pyref wiki
by Fredrik Lundh April 30, 2006

April 30, 2006

(reposted from python-dev) the pytut wiki (http://pytut.infogami.com/) has now been up and running for one month, and has seen well over 250 edits from over a dozen contributors. to celebrate this, and to exercise the toolchain that I've deve- loped for pytut and pyfaq (http://pyfaq.infogami.com/), I spent a few hours putting together a hyperlinked mashup of the language reference and portions of the library reference: http://pyref.infogami.com/ a couple of notes: - all important "concepts" have unique URLs: this includes key- words, types, special methods and attributes, statements, builtin functions, and exceptions. - the conversion and structure is a bit rough; especially the syntax/data model/execution model parts needs some serious refactoring. the "concept pages" are in a lot better shape. - registered users can add comments to all pages (editing is currently "by invitation only"; mail me your infogami account if you want to help!) - the documentation style used at the pyref site is tuned for authoring; an "end-user rendering" for python.org can look a lot different. (all three sites can be made available in glorious XHTML for inclusion in arbitrary toolchains). enjoy! </F>

1 0

Generating customized LaTeX?
by Dinu Gherman April 27, 2006

April 27, 2006

Hi, I'm working on a project where I'd greatly benefit from generating customized LaTeX from ReST, mainly for using existing LaTeX macros, basically for stuff like itemized lists, tables, figures, and code listings. After briefly sniffing into docutils 0.4 I found a "newlatex2e" writer, which makes me wonder if this would be a better start than the older "latex2e" one? But the older one contains methods like LaTeXTranslator.visit_admonition(...) which seem useful to me (in this case for listings maybe). Maybe there is some short text describing how to derive such a customized version of a docutils writer? And yes, I am aware of a simpler solution using the |...| syntax combined with raw:: LaTeX without having to subclass or rewrite a docutils writer, but the shortcoming with that is it doesn't quite work well with multiple output formats (like HTML + LaTeX, say). Thanks, Dinu

2 1

good style guides for python-style documentation ?
by Fredrik Lundh April 6, 2006

April 6, 2006

over at the pytut wiki, "carndt" asked: Are there any guidelines about conventions concerning punctuation, text styles and language style (e.g. how to address the reader)? any suggestions from this list ? </F>

1 0

introducing the experimental pytut wiki
by Fredrik Lundh April 6, 2006

April 6, 2006

without further ado, here's http://pytut.infogami.com/ inspired by http://article.gmane.org/gmane.comp.python.general/455724 and related to several earlier threads on this mailing list. </F>

1 1