did we ever resolve whether sphinx supported "replaceable" markup?

did we ever resolve whether sphinx supported "replaceable" markup?

[Robert P. J. Day]

  longer ago than i care to remember, i mentioned that one thing i
missed about docbook was the notion of the <replaceable> markup, which
emphasized that something was merely a placeholder for an actual
value -- this was normally rendered in italics.

  i ask since it would be nice to have the same thing, since in the
dev manual i am currently proofing, there's this code snippet:

  $ source oe-init-build-env [build_dir]

where "[]" is clearly meant to imply replaceable, and yet, only a few
lines further down:

  $ bitbake target

where "target" is also clearly meant to be replaceable, but there is
no markup to imply that, so it's kind of inconsistent.

  i'm guessing there's no easy way to do this, other than perhaps to
define another sphinx directive if it seems worth it.

rday

Re: [docs] did we ever resolve whether sphinx supported "replaceable" markup?

[Nicolas Dechesne]

On Wed, Sep 1, 2021 at 10:56 AM Robert P. J. Day <rpjday@crashcourse.ca> wrote:
>
>
>   longer ago than i care to remember, i mentioned that one thing i
> missed about docbook was the notion of the <replaceable> markup, which
> emphasized that something was merely a placeholder for an actual
> value -- this was normally rendered in italics.

This is the discussion you are referring to here:
https://lists.yoctoproject.org/g/docs/topic/77954380#567

It remains a good idea, and I am not aware of anything done since. It
is potentially something that could be brought up with the Sphinx
community as it is a generic question that might be interesting much
beyond our use cases.


>
>   i ask since it would be nice to have the same thing, since in the
> dev manual i am currently proofing, there's this code snippet:
>
>   $ source oe-init-build-env [build_dir]
>
> where "[]" is clearly meant to imply replaceable, and yet, only a few
> lines further down:
>
>   $ bitbake target
>
> where "target" is also clearly meant to be replaceable, but there is
> no markup to imply that, so it's kind of inconsistent.
>
>   i'm guessing there's no easy way to do this, other than perhaps to
> define another sphinx directive if it seems worth it.
>
> rday
>
> 
>