[ovs-dev] [PATCH 6/9] doc: Convert INSTALL.Windows to rST

Russell Bryant russell at ovn.org
Tue Oct 18 19:55:50 UTC 2016


On Tue, Oct 18, 2016 at 2:55 PM, Stephen Fincane <stephen at that.guru> wrote:

> On Tue, 2016-10-18 at 14:18 -0400, Russell Bryant wrote:
> > The old doc used "% command" as the prompt prefix.  I see that in the
> > new doc it is "$ command".  I'm not a Windows person, but from a
> > quick look, I think "> command" may be the most natural thing to use,
> > so I converted it to that.
>
> I could be wrong, but I *think* it has to be '$' for syntax
> highlighting to work correctly (I initially used '#' for sudo command,
> per OpenStack docs guide, but that didn't parse). No matter though -
> we'll switch to '.. code-block:: bash' style markup once we move to
> Sphinx which should resolve this anyway :)
>

No syntax highlighting is happening in the current HTML renders of these
docs, so I didn't notice.  I already pushed this, but we can change it when
we get to sphinx if needed.

-- 
Russell Bryant



More information about the dev mailing list