Re: [Doc-SIG] helping with documentation

2012-07-06 Thread Chris Jerdonek
> From: Ned Deily > Date: Thu, 05 Jul 2012 12:50:56 -0700 >> For previewing and checking purposes, what is the preferred command to >> generate HTML files from the *.rst files in source control? > > Use hg to create a current Python source directory, then look at > Doc/README.txt. Basically, you

[Doc-SIG] helping with documentation

2012-07-05 Thread Chris Jerdonek
Hi, I'd like to work on some documentation issues in the tracker, but I have a few questions before getting started. For previewing and checking purposes, what is the preferred command to generate HTML files from the *.rst files in source control? The documentation here-- http://docs.python.org/

Re: [Doc-SIG] non-ascii docstrings

2006-03-24 Thread Chris Jerdonek
On Mar 24, 2006, at 8:32 PM, Edward Loper wrote: > David Goodger wrote: >>> In particular, the question is whether I should assume that the >>> docstring is encoded with the encoding specified by the "-*- coding >>> -*-" directive at the top of the file. >> >> Yes, it's unreasonable. But such cod

Re: [Doc-SIG] Improving the documenting process.

2006-01-03 Thread Chris Jerdonek
On Jan 2, 2006, at 8:00 PM, Nick Coghlan wrote: >d. General questions/comments are directed towards the email address > "[EMAIL PROTECTED]". I'm not sure *who* ends up getting those, but I'm a > little > surprised it doesn't simply redirect to "doc-sig@python.org". (I could > be > wrong here

Re: [Doc-SIG] Improving the documenting process.

2006-01-02 Thread Chris Jerdonek
On Jan 2, 2006, at 5:17 PM, Laura Creighton wrote: > Chad suggested I post this reply to him back to doc-sig, and see > if there are others like me who think that the python documentation > problem centres around 'not enough good documentation being > produced' and a process that is opaque, has bo

[Doc-SIG] new to documenting python

2005-12-28 Thread Chris Jerdonek
Hi, I'm new to this list. I read in "Documenting Python" that you're discussing/starting to migrate from LaTeX markup to XML. If I'm interested in learning to write documentation for a Python application, does it still make sense for me to learn using your LaTeX approach? When do you expect