From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Cc: Quentin Schulz <foss@0leil.net>,
YP docs mailing list <docs@lists.yoctoproject.org>
Subject: Re: [docs] adding more glossary links in the glossary
Date: Thu, 29 Oct 2020 05:35:44 -0400 (EDT) [thread overview]
Message-ID: <336c445d-a1d-081-7d1a-c6f62bcceb72@crashcourse.ca> (raw)
In-Reply-To: <CAP71WjxjpKNusUURNydfrTg4G0G0BQUaEq9J4vTmDE2c4xA1bA@mail.gmail.com>
On Thu, 29 Oct 2020, Nicolas Dechesne wrote:
... snip ...
> This specific syntax bothers me a lot.. one reason we moved to
> Sphinx was to have 'simple' documentation source and this specific
> syntax is horrifying.. if it's a pattern we use a lot, perhaps we
> should create a custom role for that, like :term2: for example, so
> that :term2:`PACKAGES` would add the ${} and the fixed-font
> rendering.
... snip ...
ah, irony ... while sphinx is so much easier to write, the one thing
i truly miss about docbook/XML is the semantic markup, which is
exactly what you're proposing. :-) again, i missed a lot of the recent
discussion on this list, being coincidentally buried in yocto project
work, but it seems that a simple solution would be to restore just a
wee bit of that semantic markup as above by defining, say "glossterm":
:glossterm:`PACKAGES`
and let sphinx take it from there.
that could be a massively stupid suggestion as i'm still perusing
the sphinx docs to truly understand how it works.
rday
next prev parent reply other threads:[~2020-10-29 9:35 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-29 8:13 adding more glossary links in the glossary Robert P. J. Day
2020-10-29 8:56 ` [docs] " Quentin Schulz
2020-10-29 9:12 ` Robert P. J. Day
2020-10-29 9:18 ` Nicolas Dechesne
2020-10-29 9:35 ` Robert P. J. Day [this message]
2020-10-29 10:22 ` Quentin Schulz
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=336c445d-a1d-081-7d1a-c6f62bcceb72@crashcourse.ca \
--to=rpjday@crashcourse.ca \
--cc=docs@lists.yoctoproject.org \
--cc=foss@0leil.net \
--cc=nicolas.dechesne@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.