From: Diederik de Haas <didi.debian@cknow.org>
To: Akira Yokosawa <akiyks@gmail.com>
Cc: bagasdotme@gmail.com, linux-doc@vger.kernel.org,
Akira Yokosawa <akiyks@gmail.com>
Subject: Re: checkpatch doc suggestion
Date: Mon, 13 May 2024 11:53:29 +0200 [thread overview]
Message-ID: <2161177.vmPJLRX1GE@bagend> (raw)
In-Reply-To: <be8b3af7-18bf-4bc4-9951-413d6bfb6796@gmail.com>
[-- Attachment #1: Type: text/plain, Size: 1507 bytes --]
On Monday, 13 May 2024 07:08:55 CEST Akira Yokosawa wrote:
> > Thanks to your hint and some experimentation, I managed to add id
> > attributes to the various ``dl`` elements and can directly reference the
> > tags :-)
> >
> > But I noticed 2 things in the generated HTML documentation:
> > 1) The id attributes are all lowercase, regardless of how I defined them
> > in ``checkpatch.rst``
> > 2) The underscores (``_``) have been replaced with dashes (``-``)
> >
> > So instead of linking to checkpatch.html#BAD_FIXES_TAG I have to link to
> > checkpatch.html#bad-fixes-tag. I was hoping that I could get the literal
> > tags names (including underscores and uppercase letters) as id attribute.
> >
> > Is something rst/sphinx always does or did I do something wrong?
>
> For authoritative info, I'd suggest consulting the reST reference for
> "Hyperlink Targets" at:
>
> https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlin
> k-targets
>
> and "Hyperlink References" at:
>
> https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlin
> k-references
>
> , and other related sections therein.
https://docutils.sourceforge.io/docs/ref/rst/directives.html#identifier-normalization
taught me the reason why those conversions happened, so I'll use the
normalized version in my patch submission as well so that there's a 1-on-1
match between the source and the generated id attribute in the html docs.
> HTH, Akira
It sure did, thanks!
Cheers,
Diederik
[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
prev parent reply other threads:[~2024-05-13 9:53 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-30 10:56 checkpatch doc suggestion Diederik de Haas
2024-05-03 12:55 ` Bagas Sanjaya
2024-05-06 13:59 ` Diederik de Haas
2024-05-08 0:16 ` Bagas Sanjaya
2024-05-12 15:58 ` Diederik de Haas
2024-05-13 5:08 ` Akira Yokosawa
2024-05-13 9:53 ` Diederik de Haas [this message]
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=2161177.vmPJLRX1GE@bagend \
--to=didi.debian@cknow.org \
--cc=akiyks@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=linux-doc@vger.kernel.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).