From chris.jerdonek at gmail.com  Thu Jul  5 21:14:37 2012
From: chris.jerdonek at gmail.com (Chris Jerdonek)
Date: Thu, 5 Jul 2012 12:14:37 -0700
Subject: [Doc-SIG] helping with documentation
Message-ID: <CAOTb1wfd8Q2HM=ugAj_kBUNeci1Drw9igPFg+=1GwNk-iD6GOg@mail.gmail.com>

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/devguide/docquality.html

mentions a `Doc/tools/dailybuild.py` script, but that script doesn't
seem to exist any longer

Also, is there a recommended way to check documentation submissions
for style in advance?  I see an `rstlint.py` script in that same
`Doc/tools` directory, so perhaps using that with some invocation is
the recommended way.

Lastly, if any of this is spelled out elsewhere like on a web page or
in a prior e-mail, pointing me to that would be great.

Thanks,
--Chris

From nad at acm.org  Thu Jul  5 21:50:56 2012
From: nad at acm.org (Ned Deily)
Date: Thu, 05 Jul 2012 12:50:56 -0700
Subject: [Doc-SIG] helping with documentation
References: <CAOTb1wfd8Q2HM=ugAj_kBUNeci1Drw9igPFg+=1GwNk-iD6GOg@mail.gmail.com>
Message-ID: <nad-FBD6DC.12505605072012@news.gmane.org>

In article 
<CAOTb1wfd8Q2HM=ugAj_kBUNeci1Drw9igPFg+=1GwNk-iD6GOg at mail.gmail.com>,
 Chris Jerdonek <chris.jerdonek at gmail.com> wrote:
> 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 should just need to run "cd Doc; make 
html".

-- 
 Ned Deily,
 nad at acm.org


From chris.jerdonek at gmail.com  Fri Jul  6 13:06:51 2012
From: chris.jerdonek at gmail.com (Chris Jerdonek)
Date: Fri, 6 Jul 2012 04:06:51 -0700
Subject: [Doc-SIG] helping with documentation
Message-ID: <CAOTb1wegyU2+WrHTtGidA8HqsLZZ=pmagex+=xwJnnXqy5nEsw@mail.gmail.com>

> From: Ned Deily <nad at acm.org>
> 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 should just need to run "cd Doc; make
> html".

Thanks.  On the web this information can be found here:

http://docs.python.org/devguide/documenting.html#building-the-documentation

I was looking in the wrong place.  Regarding linting, it looks like
"cd Doc; make check" works.  Or alternatively, to check a single file:
"python tools/rstlint.py path-to-file.rst".

--Chris