diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2024-03-30 17:32:47 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-04-08 14:36:38 +0100 |
| commit | ae1b8c607909d108d994386ad6e78f1f0422e174 (patch) | |
| tree | 771b72af5b7135c81d7f10b118da695327728290 /documentation/Makefile | |
| parent | 69817122507de2d7cdcbcc3d1bfa6c19592a9576 (diff) | |
| download | poky-ae1b8c607909d108d994386ad6e78f1f0422e174.tar.gz | |
manuals: add initial sphinx-lint support
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".
(From yocto-docs rev: 9e1aeeddca06cb7d65631010ba0eebdcd8ecf9ee)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/Makefile')
| -rw-r--r-- | documentation/Makefile | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/documentation/Makefile b/documentation/Makefile index f3b775b3ec..189bd1dfac 100644 --- a/documentation/Makefile +++ b/documentation/Makefile | |||
| @@ -53,6 +53,9 @@ stylecheck: | |||
| 53 | vale sync | 53 | vale sync |
| 54 | vale $(VALEOPTS) $(VALEDOCS) | 54 | vale $(VALEOPTS) $(VALEDOCS) |
| 55 | 55 | ||
| 56 | sphinx-lint: | ||
| 57 | sphinx-lint $(SOURCEDIR) | ||
| 58 | |||
| 56 | epub: $(PNGs) | 59 | epub: $(PNGs) |
| 57 | $(SOURCEDIR)/set_versions.py | 60 | $(SOURCEDIR)/set_versions.py |
| 58 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | 61 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |