[GRASS-git] [OSGeo/grass] 74d41f: docs: Remove Keywords section from generated doc (...

Vaclav Petras noreply at github.com
Wed Mar 26 18:44:45 PDT 2025


  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 74d41f0b0040d98e95b898d760337be1e713a79c
      https://github.com/OSGeo/grass/commit/74d41f0b0040d98e95b898d760337be1e713a79c
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2025-03-26 (Wed, 26 Mar 2025)

  Changed paths:
    M general/g.mkfontcap/main.c
    M general/g.parser/g.parser.md
    M gui/wxpython/docs/wxGUI.components.md
    M gui/wxpython/docs/wxGUI.iscatt.md
    M gui/wxpython/docs/wxGUI.modules.md
    M gui/wxpython/docs/wxGUI.nviz.md
    M gui/wxpython/docs/wxGUI.toolboxes.md
    M gui/wxpython/docs/wxGUI.vnet.md
    M gui/wxpython/iclass/g.gui.iclass.md
    M gui/wxpython/rdigit/g.gui.rdigit.md
    M lib/gis/parser_md.c
    M man/build_topics.py

  Log Message:
  -----------
  docs: Remove Keywords section from generated doc (#5444)

This removes the Keywords section from the generated documentation in favor of showing MkDocs generated tags.

This also adds keywords to metadata of some files replacing a hard-coded Keywords section and adding keywords so there is at least two keywords when keywords are present.

There are two major differences:

1. The MkDocs tags are alphabetically ordered and are at the top of the page as "bubbles" instead of priority ordered tags as text inside a section.

2. All the tags go to the same page with a list of tags and a list of pages with each tag. This is like the original keywords index just with bubbles instead of plain headings. There is no distinction made for the first keyword being a category (raster, vector, ...) - going to category index - and second keyword being a topic - going to a topic page.

This preserves the current topic functionality which depends on the presence of keywords which are now obtained from the metadata rather than from parsing the Markdown text. Unlike the tool categories (raster, vector, ...), the topics are not linked from the menu at this point.



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


More information about the grass-commit mailing list