[Doc-SIG] helping with documentation

Chris Jerdonek chris.jerdonek at gmail.com
Fri Jul 6 13:06:51 CEST 2012


> 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


More information about the Doc-SIG mailing list