[GRASS-git] [OSGeo/grass] 08286f: docs: Use YAML list for keywords in front matter (...

[Vaclav Petras]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 08286fbe4ac267017a7a39c3189b59cbe03bf2ce
      https://github.com/OSGeo/grass/commit/08286fbe4ac267017a7a39c3189b59cbe03bf2ce
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2025-03-07 (Fri, 07 Mar 2025)

  Changed paths:
    M gui/wxpython/timeline/g.gui.timeline.py
    M gui/wxpython/tplot/g.gui.tplot.py
    M lib/gis/parser_md.c
    M man/build_keywords.py
    M man/mkdocs/tags.md

  Log Message:
  -----------
  docs: Use YAML list for keywords in front matter (#5320)

To use the keywords directly in MkDocs, keywords property needs to be proper YAML list, not a plain comma-separated list as a string. The keywords are now generated like that, and the custom keyword parsing now accepts both version (with and without []).

This does not include any keywords entered manually to Markdown because there are none in this repo, but they are in grass-addons repo which will break the MkDocs reading of the tags from the keywords property (for r.pi, r.green). Addons are addressed in https://github.com/OSGeo/grass-addons/pull/1357.

This includes cleanup of keywords tool metadata syntax which is supposed to use multiple keyword keys now rather than keywords (for a single keyword).

For the tags page generated by MkDocs, this adds an exclude of keyword 'unit test' which does not need to appear in the documentation.

This covers only the YAML changes for keywords. The MkDocs change for tags to keywords is in #5318.



To unsubscribe from these emails, change your notification settings at https://github.com/OSGeo/grass/settings/notifications