[Python-Dev] Questions/comments on documentation formatting

Raymond Hettinger python at rcn.com
Tue Jan 20 08:50:35 CET 2009


>> In particular, look at the urls for:
>>   http://docs.python.org/dev/library/collections.html#id1 versus
>>
>> http://docs.python.org/dev/library/collections.html#abcs-abstract-base-classes
>> I would like all of the targets to have meaningful names.

[Brett]
> Not sure from a sphinx perspective, but Docutils does this
> automatically. You can also always specify the anchor point manually::
> 
>  .. _abcs-abstract-base-classes
> 
>  Abstract Base Classes
>  ------------------------------
> 
> to get what you want.


Thanks for the note.  It pointed me to the real problem which was
that manual anchor points can interfere with the automatically
generated names if their names are the same.  The solution was
to *remove* the manually generated anchor points.


Raymond


More information about the Python-Dev mailing list