[GRASS-git] [OSGeo/grass] 863845: build: Allow separate build of Markdown and HTML k...

[Vaclav Petras]

  Branch: refs/heads/main
  Home:   https://github.com/OSGeo/grass
  Commit: 863845995d73c5bc8089c816e359bf4d000e7c74
      https://github.com/OSGeo/grass/commit/863845995d73c5bc8089c816e359bf4d000e7c74
  Author: Vaclav Petras <wenzeslaus at gmail.com>
  Date:   2025-02-25 (Tue, 25 Feb 2025)

  Changed paths:
    M .github/workflows/documentation.yml
    M man/build_keywords.py

  Log Message:
  -----------
  build: Allow separate build of Markdown and HTML keywords (#5177)

The original Markdown support from #3849 breaks generating addon keywords on the doc build server because the parameter for addons used in the build script was ignored. The addon keywords are currently integrated for 8.4, but are not integrated into the index for 8.5. This update should fix that.

The new code allows for the original usage of the script where documentation directories are supplied as parameters. This assumes HTML documentation and corresponds to the usage on the build server.

The intended usage from #3849 for the new build where both Markdown and HTML are build using the script without the build system providing parameters is preserved.

Finally, with parameters md <core-path> <addon-path>, the script allows for creating Markdown keyword list with optionally integrated addons using the paths provided. Unfortunately, ARCH_DISTDIR still needs to be set even in this case because it used directly a import time and a lot of other code uses that variable.

This also adds a main function to separate the variables and handle the parameters in one place. Additionally, it creates the dict for the first letter TOC only for HTML where it is used (which allows the script to execute without the fixes for empty keyword list from #5175).

Updates the CI to use the renewed API to get addon keywords into keyword index in Markdown for both core and addons.

Additionally, in the CI, it uses actual arch (just because it is possible), fixes logs dir path, uses more strict and verbose build.



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