Open Stack

Are you saying to not use the :ref: construction?

 
      From: Andreas Jaeger <aj at suse.com>
 To: Meg McRoberts <dreidellhasa at yahoo.com>; "openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org> 
 Sent: Wednesday, May 13, 2015 10:30 PM
 Subject: Re: [OpenStack-docs] Anchor tag conventions
   
On 05/13/2015 11:50 PM, Meg McRoberts wrote:


> 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 use
> in 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 Structure
> standard specifies using underbar as the space delimiter, and underbars
> in these labels can confuse
> Sphinx.
>
> 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?

You can reference files by name, can't you?

Andreas
-- 
  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
    GF: Felix Imendörffer, Jane Smithard, Dilip Upmanyu, Graham Norton,
        HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



   
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150514/3f31357b/attachment.html>