[Doc-SIG] helping with documentation

Chris Jerdonek chris.jerdonek at gmail.com
Thu Jul 5 21:14:37 CEST 2012


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


More information about the Doc-SIG mailing list