From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Akira Yokosawa" <akiyks@gmail.com>,
"Breno Leitao" <leitao@debian.org>,
"David S. Miller" <davem@davemloft.net>,
"Donald Hunter" <donald.hunter@gmail.com>,
"Eric Dumazet" <edumazet@google.com>,
"Ignacio Encinas Rubio" <ignacio@iencinas.com>,
"Jan Stancek" <jstancek@redhat.com>,
"Marco Elver" <elver@google.com>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
"Paolo Abeni" <pabeni@redhat.com>,
"Ruben Wauters" <rubenru09@aol.com>,
"Shuah Khan" <skhan@linuxfoundation.org>,
joel@joelfernandes.org, linux-kernel-mentees@lists.linux.dev,
linux-kernel@vger.kernel.org, lkmm@lists.linux.dev,
netdev@vger.kernel.org, peterz@infradead.org,
stern@rowland.harvard.edu
Subject: [PATCH v7 07/17] docs: sphinx: add a parser for yaml files for Netlink specs
Date: Thu, 19 Jun 2025 08:49:00 +0200 [thread overview]
Message-ID: <79fd88d84e63351d1156a343d697d9bbca8159c5.1750315578.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1750315578.git.mchehab+huawei@kernel.org>
Add a simple sphinx.Parser to handle yaml files and add the
the code to handle Netlink specs. All other yaml files are
ignored.
The code was written in a way that parsing yaml for different
subsystems and even for different parts of Netlink are easy.
All it takes to have a different parser is to add an
import line similar to:
from netlink_yml_parser import YnlDocGenerator
adding the corresponding parser somewhere at the extension:
netlink_parser = YnlDocGenerator()
And then add a logic inside parse() to handle different
doc outputs, depending on the file location, similar to:
if "/netlink/specs/" in fname:
msg = self.netlink_parser.parse_yaml_file(fname)
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
Documentation/sphinx/parser_yaml.py | 76 +++++++++++++++++++++++++++++
1 file changed, 76 insertions(+)
create mode 100755 Documentation/sphinx/parser_yaml.py
diff --git a/Documentation/sphinx/parser_yaml.py b/Documentation/sphinx/parser_yaml.py
new file mode 100755
index 000000000000..635945e1c5ba
--- /dev/null
+++ b/Documentation/sphinx/parser_yaml.py
@@ -0,0 +1,76 @@
+"""
+Sphinx extension for processing YAML files
+"""
+
+import os
+import re
+import sys
+
+from pprint import pformat
+
+from docutils.parsers.rst import Parser as RSTParser
+from docutils.statemachine import ViewList
+
+from sphinx.util import logging
+from sphinx.parsers import Parser
+
+srctree = os.path.abspath(os.environ["srctree"])
+sys.path.insert(0, os.path.join(srctree, "tools/net/ynl/pyynl"))
+
+from netlink_yml_parser import YnlDocGenerator # pylint: disable=C0413
+
+logger = logging.getLogger(__name__)
+
+class YamlParser(Parser):
+ """Custom parser for YAML files."""
+
+ # Need at least two elements on this set
+ supported = ('yaml', 'yml')
+
+ netlink_parser = YnlDocGenerator()
+
+ def do_parse(self, inputstring, document, msg):
+ """Parse YAML and generate a document tree."""
+
+ self.setup_parse(inputstring, document)
+
+ result = ViewList()
+
+ try:
+ # Parse message with RSTParser
+ for i, line in enumerate(msg.split('\n')):
+ result.append(line, document.current_source, i)
+
+ rst_parser = RSTParser()
+ rst_parser.parse('\n'.join(result), document)
+
+ except Exception as e:
+ document.reporter.error("YAML parsing error: %s" % pformat(e))
+
+ self.finish_parse()
+
+ # Overrides docutils.parsers.Parser. See sphinx.parsers.RSTParser
+ def parse(self, inputstring, document):
+ """Check if a YAML is meant to be parsed."""
+
+ fname = document.current_source
+
+ # Handle netlink yaml specs
+ if "/netlink/specs/" in fname:
+ msg = self.netlink_parser.parse_yaml_file(fname)
+ self.do_parse(inputstring, document, msg)
+
+ # All other yaml files are ignored
+
+def setup(app):
+ """Setup function for the Sphinx extension."""
+
+ # Add YAML parser
+ app.add_source_parser(YamlParser)
+ app.add_source_suffix('.yaml', 'yaml')
+
+ return {
+ 'version': '1.0',
+ 'parallel_read_safe': True,
+ 'parallel_write_safe': True,
+ }
--
2.49.0
next prev parent reply other threads:[~2025-06-19 6:50 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-19 6:48 [PATCH v7 00/17] Don't generate netlink .rst files inside $(srctree) Mauro Carvalho Chehab
2025-06-19 6:48 ` [PATCH v7 01/17] docs: conf.py: properly handle include and exclude patterns Mauro Carvalho Chehab
2025-06-19 6:48 ` [PATCH v7 02/17] docs: Makefile: disable check rules on make cleandocs Mauro Carvalho Chehab
2025-06-19 6:48 ` [PATCH v7 03/17] docs: netlink: netlink-raw.rst: use :ref: instead of :doc: Mauro Carvalho Chehab
2025-06-19 8:57 ` Donald Hunter
2025-06-19 6:48 ` [PATCH v7 04/17] tools: ynl_gen_rst.py: Split library from command line tool Mauro Carvalho Chehab
2025-06-19 12:01 ` Donald Hunter
2025-06-20 10:58 ` Mauro Carvalho Chehab
2025-06-19 6:48 ` [PATCH v7 05/17] docs: netlink: index.rst: add a netlink index file Mauro Carvalho Chehab
2025-06-19 6:48 ` [PATCH v7 06/17] tools: ynl_gen_rst.py: cleanup coding style Mauro Carvalho Chehab
2025-06-19 12:04 ` Donald Hunter
2025-06-19 6:49 ` Mauro Carvalho Chehab [this message]
2025-06-19 12:08 ` [PATCH v7 07/17] docs: sphinx: add a parser for yaml files for Netlink specs Donald Hunter
2025-06-19 6:49 ` [PATCH v7 08/17] docs: use parser_yaml extension to handle " Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 09/17] docs: uapi: netlink: update netlink specs link Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 10/17] tools: ynl_gen_rst.py: drop support for generating index files Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 11/17] docs: netlink: remove obsolete .gitignore from unused directory Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 12/17] MAINTAINERS: add netlink_yml_parser.py to linux-doc Mauro Carvalho Chehab
2025-06-19 12:10 ` Donald Hunter
2025-06-19 6:49 ` [PATCH v7 13/17] tools: netlink_yml_parser.py: add line numbers to parsed data Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 14/17] docs: parser_yaml.py: add support for line numbers from the parser Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 15/17] docs: sphinx: add a file with the requirements for lowest version Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 16/17] docs: conf.py: several coding style fixes Mauro Carvalho Chehab
2025-06-19 6:49 ` [PATCH v7 17/17] docs: conf.py: Check Sphinx and docutils version Mauro Carvalho Chehab
2025-06-19 8:29 ` [PATCH v7 00/17] Don't generate netlink .rst files inside $(srctree) Donald Hunter
2025-06-20 10:33 ` Mauro Carvalho Chehab
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=79fd88d84e63351d1156a343d697d9bbca8159c5.1750315578.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=donald.hunter@gmail.com \
--cc=edumazet@google.com \
--cc=elver@google.com \
--cc=ignacio@iencinas.com \
--cc=joel@joelfernandes.org \
--cc=jstancek@redhat.com \
--cc=leitao@debian.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel-mentees@lists.linux.dev \
--cc=linux-kernel@vger.kernel.org \
--cc=lkmm@lists.linux.dev \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=peterz@infradead.org \
--cc=rubenru09@aol.com \
--cc=skhan@linuxfoundation.org \
--cc=stern@rowland.harvard.edu \
/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).