From: Michael Opdenacker <michael.opdenacker@bootlin.com>
To: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Cc: docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH] manuals: add initial sphinx-lint support
Date: Tue, 2 Apr 2024 15:22:35 +0200 [thread overview]
Message-ID: <0d593094-f76a-4760-aeca-01098a61e979@bootlin.com> (raw)
In-Reply-To: <803f3abd-3c31-4b5f-a47a-63336f7bcd9c@theobroma-systems.com>
Hi Quentin
On 4/2/24 at 11:59, Quentin Schulz wrote:
> Hi Michael,
>
> On 3/30/24 17:36, Michael Opdenacker via lists.yoctoproject.org wrote:
>> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
>>
>> Makes it possible to catch errors not reported by sphinx,
>> such as idle spaces. After customization, this should be used
>> to enforce our syntax conventions, such as two spaces after a "-"
>> character to introduce a list item.
>>
>> Just run "make sphinx-lint".
>>
>> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
>> ---
>> documentation/Makefile | 3 +++
>> documentation/README | 14 ++++++++++++++
>> 2 files changed, 17 insertions(+)
>>
>> diff --git a/documentation/Makefile b/documentation/Makefile
>> index f3b775b3ec..cacb51c036 100644
>> --- a/documentation/Makefile
>> +++ b/documentation/Makefile
>> @@ -53,6 +53,9 @@ stylecheck:
>> vale sync
>> vale $(VALEOPTS) $(VALEDOCS)
>> +sphinx-lint:
>> + sphinx-lint
>> +
>
> I would pass $(SOURCEDIR) as argument as well.
Good idea!
I modified my branch.
Thanks
Michael.
--
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
prev parent reply other threads:[~2024-04-02 13:22 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-30 16:36 [PATCH] manuals: add initial sphinx-lint support michael.opdenacker
2024-04-02 7:53 ` [docs] " Jörg Sommer
2024-04-02 9:23 ` Michael Opdenacker
2024-04-02 9:59 ` Quentin Schulz
2024-04-02 13:22 ` Michael Opdenacker [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=0d593094-f76a-4760-aeca-01098a61e979@bootlin.com \
--to=michael.opdenacker@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=quentin.schulz@theobroma-systems.com \
/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).