[PATCH v10 08/14] tools: ynl_gen_rst.py: drop support for generating index files

Mauro Carvalho Chehab
2025-07-28T16:02:22Z

As we're now using an index file with a glob, there's no need
to generate index files anymore.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Donald Hunter <donald.hunter@gmail.com>
---
tools/net/ynl/pyynl/ynl_gen_rst.py | 28 ----------------------------
1 file changed, 28 deletions(-)

diff --git a/tools/net/ynl/pyynl/ynl_gen_rst.py b/tools/net/ynl/pyynl/ynl_gen_rst.py
index 010315fad498..90ae19aac89d 100755
--- a/tools/net/ynl/pyynl/ynl_gen_rst.py
+++ b/tools/net/ynl/pyynl/ynl_gen_rst.py
@@ -31,9 +31,6 @@ def parse_arguments() -> argparse.Namespace:

# Index and input are mutually exclusive
group = parser.add_mutually_exclusive_group()
- group.add_argument(
- "-x", "--index", action="store_true", help="Generate the index page"
- )
group.add_argument("-i", "--input", help="YAML file name")

args = parser.parse_args()
@@ -63,27 +60,6 @@ def write_to_rstfile(content: str, filename: str) -> None:
rst_file.write(content)

-def generate_main_index_rst(parser: YnlDocGenerator, output: str) -> None:
- """Generate the `networking_spec/index` content and write to the file"""
- lines = []
-
- lines.append(parser.fmt.rst_header())
- lines.append(parser.fmt.rst_label("specs"))
- lines.append(parser.fmt.rst_title("Netlink Family Specifications"))
- lines.append(parser.fmt.rst_toctree(1))
-
- index_dir = os.path.dirname(output)
- logging.debug("Looking for .rst files in %s", index_dir)
- for filename in sorted(os.listdir(index_dir)):
- base, ext = os.path.splitext(filename)
- if filename == "index.rst" or ext not in [".rst", ".yaml"]:
- continue
- lines.append(f" {base}\n")
-
- logging.debug("Writing an index file at %s", output)
- write_to_rstfile("".join(lines), output)
-
-
def main() -> None:
"""Main function that reads the YAML files and generates the RST files"""

@@ -102,10 +78,6 @@ def main() -> None:

write_to_rstfile(content, args.output)

- if args.index:
- # Generate the index RST file
- generate_main_index_rst(parser, args.output)
-

if __name__ == "__main__":
main()
--
2.49.0