[OpenStack-docs] Anchor tag conventions
Meg McRoberts
dreidellhasa at yahoo.com
Wed May 13 21:50:07 UTC 2015
Hi all,I am creating files for the ha-guide content and have a question about what the OpenStack docs call"embedded anchor pointers" and the Sphinx docs call labels. Basically, this is the string that you usein a :ref: construct to link to a section. It is coded just above the section title. For example:
.. _anchor-for-ha-intro:
============================================Introduction to Highly Available OpenStack environments============================================
It makes sense to use the file name (minus the .rst extension) for the labels, except that the Structurestandard specifies using underbar as the space delimiter, and underbars in these labels can confuseSphinx.
I would suggest one of the following:
- Use hyphen rather than underscore for RST source file names, then use that name as the top-level label for that section, so the filename would be intro-ha.rst rather than intro_ha.rst (preferred)
- Replace the underbars in file names with hyphens for labels.
What does everyone else think?meg
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150513/c8d6fc4f/attachment.html>
More information about the OpenStack-docs
mailing list