[Python-Dev] [Python-checkins] cpython: Fix syntax in packaging docs and update suspicious ignore file.

[Georg Brandl]

Am 12.07.2011 15:30, schrieb Éric Araujo:
>> changeset:   71283:3a4b983dd70b
>> user:        Georg Brandl <georg at python.org>
>> summary:
>>   Fix syntax in packaging docs and update suspicious ignore file.
>> 
>> files:
>>   Doc/library/packaging.compiler.rst   |   2 +-
>>   Doc/packaging/builtdist.rst          |   2 +-
>>   Doc/packaging/commandref.rst         |   2 +-
> 
> Thanks for the fixes, Georg.  I fix problems when I get warnings, but
> these fell through.  Maybe you used a special command line to find those?

Yes: "make suspicious" in the Doc directory invokes the special builder that
looks for things that look like reST markup in the output, where it shouldn't
occur.  This is a routine step in PEP 101, so it will be done before every
release.

>>   Doc/tools/sphinxext/susp-ignored.csv |  27 ++++++++++++++-
> 
> I’ve always wondered about that file’s role, and I’ve finally found
> answers in Doc/tools/sphinxext/suspicious.py.  Should we update this
> file when we get suspicious output?  Does using “.. block-code:: none”
> prevent program output from appearing as suspicious?

No (and neither do normal code blocks).  That is one thing that should be
improved in the builder: the content of code blocks ("literal" nodes in
docutils) shouldn't be checked.

Georg