[OpenStack-docs] Style Question for files, commands, etc

Meg McRoberts dreidellhasa at yahoo.com
Mon Jun 1 18:15:08 UTC 2015


Thanks for the clarification, Andreas -- I had missed the single quotes before and after the file nameso it didn't work ;-)

 
      From: Andreas Jaeger <aj at suse.com>
 To: Meg McRoberts <dreidellhasa at yahoo.com> 
Cc: "openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org> 
 Sent: Monday, June 1, 2015 2:55 AM
 Subject: Re: [OpenStack-docs] Style Question for files, commands, etc
   
On 06/01/2015 11:07 AM, Meg McRoberts wrote:


> The list of markup conventions talks about using :file: , :command: and
> so forth in RST.
> I don't find anything about these in the Sphinx documentation and I
> tried using :file: and
> it prints out as a literal in the text.  Am I missing something or is
> this an error?
>
> How is one supposed to handle file and command names, etc?

Check:
http://sphinx-doc.org/markup/inline.html#other-semantic-markup

Yes, those are printed as literal which is fine. We use semantic markup 
and let our tools do the formatting,

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/20150601/9c1f5112/attachment.html>


More information about the OpenStack-docs mailing list