Skip to content

Commit

Permalink
doc: Hide only general and misc keywords in index (#5056)
Browse files Browse the repository at this point in the history
When a tool links raster or vector as a standard keyword, the link to keyword page does not go anywhere because first keyword (aka class or family) is hidden in the keywords index (overview).

This enables most of the keywords with the exception of general and misc which I assume will not be used by non-general tools as keywords.

Fixes #5049.

In addition, this changes the variable names for better documentation.
  • Loading branch information
wenzeslaus authored Feb 7, 2025
1 parent f5db1b5 commit cbd62b7
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions man/build_keywords.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,9 @@
import sys
import glob

blacklist = [
"Display",
"Database",
keywords_to_hide_in_overview = [
"General",
"Imagery",
"Misc",
"Postscript",
"Raster",
"Raster3D",
"Temporal",
"Vector",
]

addons_path = None
Expand Down Expand Up @@ -114,12 +106,12 @@ def build_keywords(ext):
elif fname not in keywords[key]:
keywords[key].append(fname)

for black in blacklist:
for keyword in keywords_to_hide_in_overview:
try:
del keywords[black]
del keywords[keyword]
except Exception:
try:
del keywords[black.lower()]
del keywords[keyword.lower()]
except Exception:
continue

Expand Down

0 comments on commit cbd62b7

Please sign in to comment.