[Python-Dev] Questions/comments on documentation formatting

Brett Cannon brett at python.org
Tue Jan 20 06:58:25 CET 2009


On Mon, Jan 19, 2009 at 19:50, Raymond Hettinger <python at rcn.com> wrote:
> I have another question about doc formatting.
>
> What controls whether section headers get urls with a custom named jump
> target instead of a default name like "id1"?
>
> 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.

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.

-Brett


More information about the Python-Dev mailing list