@@ -190,13 +196,80 @@ def generate_page_for_category(
replace_file(filename)
+def generate_page_for_category_md(
+ short_family, module_family, imgs, year, skip_no_image=False
+):
+ filename = module_family + "_graphical.md"
+ with open(filename + ".tmp", "w") as output:
+ output.write(graphical_index_style)
+
+ if module_family.lower() not in {"general", "postscript"}:
+ if module_family == "raster3d":
+ # covert keyword to nice form
+ module_family = "3D raster"
+ output.write(
+ modclass_intro_tmpl.substitute(
+ modclass=module_family, modclass_lower=module_family.lower()
+ )
+ )
+ if module_family == "wxGUI":
+ output.write("# wxGUI components\n")
+ elif module_family == "guimodules":
+ output.write("# g.gui.* modules\n")
+ else:
+ output.write("# {0} tools\n".format(to_title(module_family)))
+ output.write('
')
+
+ # for all modules:
+ for cmd in get_files(
+ build_md.man_dir, short_family, ignore_gui=False, extension="md"
+ ):
+ basename = os.path.splitext(cmd)[0]
+ desc = check_for_desc_override(basename)
+ if desc is None:
+ desc = build_md.get_desc(cmd)
+ img = get_module_image(basename, imgs)
+ img_class = "linkimg"
+ if skip_no_image and not img:
+ continue
+ if not img:
+ img = "grass_logo.png"
+ img_class = "default-img"
+ if basename.startswith("wxGUI"):
+ basename = basename.replace(".", " ")
+ output.write(
+ "- "
+ ''
+ '
'
+ ""
+ ''
+ '{name} '
+ '{desc}'
+ ""
+ " ".format(
+ html=cmd.removesuffix(".md"),
+ img=img,
+ name=basename,
+ desc=desc,
+ img_class=img_class,
+ )
+ )
+
+ output.write("
")
+
+ write_footer(output, "index.html", year, template="md")
+
+ replace_file(filename)
+
+
# TODO: dependencies in makefile for this have to be fixed
# TODO: there is a potential overlap with other scripts (-> refactoring)
def main():
year = default_year
- html_dir = sys.argv[1]
+ output_format = sys.argv[1]
+ html_dir = sys.argv[2]
os.chdir(html_dir)
img_extensions = ["png", "jpg", "gif"]
@@ -227,16 +300,24 @@ def main():
# partial compatibility with build_class.py
# first arg is dist html dir but the 3 other are like first 3 there
- if len(sys.argv) > 2:
- short_family = sys.argv[2]
- module_family = sys.argv[3]
- if len(sys.argv) > 4:
- year = sys.argv[4]
+ if len(sys.argv) > 3:
+ short_family = sys.argv[3]
+ module_family = sys.argv[4]
+ if len(sys.argv) > 5:
+ year = sys.argv[5]
for short_family, module_family in families:
- generate_page_for_category(
- short_family, module_family, imgs, year=year, skip_no_image=False
- )
+ if output_format == "html":
+ generate_page_for_category(
+ short_family, module_family, imgs, year=year, skip_no_image=False
+ )
+ elif output_format == "md":
+ generate_page_for_category_md(
+ short_family, module_family, imgs, year=year, skip_no_image=False
+ )
+ else:
+ msg = f"Unknown format: {output_format}"
+ raise ValueError(msg)
if __name__ == "__main__":
diff --git a/man/build_graphical_index.py b/man/build_graphical_index.py
index bc7dd5299d9..f29feef786b 100755
--- a/man/build_graphical_index.py
+++ b/man/build_graphical_index.py
@@ -87,8 +87,8 @@ def main(ext):
)
else:
output.write(
- "- []({link})".format(
- link=html_file, img=image, name=label
+ "- []({link}.md)".format(
+ link=html_file.removesuffix(".html"), img=image, name=label
)
)
diff --git a/man/build_topics.py b/man/build_topics.py
index 2ef3e8c57df..a9a42ea3108 100644
--- a/man/build_topics.py
+++ b/man/build_topics.py
@@ -61,7 +61,12 @@ def build_topics(ext):
try:
desc = lines[index_desc].split("-", 1)[1].strip()
except Exception:
- desc.strip()
+ desc = desc.strip()
+
+ # Line ending can appear here on Windows.
+ key = key.strip()
+ if not key:
+ continue
if key not in keywords.keys():
keywords[key] = {}
@@ -102,7 +107,7 @@ def build_topics(ext):
topicsfile.writelines(
[
moduletopics_tmpl.substitute(
- key=key, name=key.replace("_", " ")
+ key=key.replace(" ", "_"), name=key.replace("_", " ")
)
]
)
@@ -125,9 +130,10 @@ def build_topics(ext):
# expecting markdown
keyfile.write(
"*See also the corresponding keyword"
- " [{key}](keywords.md#{key})"
+ " [{name}](keywords.md#{key})"
" for additional references.*\n".format(
- key=key.replace(" ", "-").replace("_", "-").lower()
+ key=key.replace(" ", "-").replace("_", "-").lower(),
+ name=key.replace("_", " "),
)
)
diff --git a/raster/Makefile b/raster/Makefile
index a8f00ee9c7c..a571f47f1e2 100644
--- a/raster/Makefile
+++ b/raster/Makefile
@@ -44,7 +44,6 @@ SUBDIRS = \
r.latlong \
r.lake \
r.li \
- r.mapcalc \
r.mask.status \
r.mfilter \
r.mode \
diff --git a/raster/r.colors/Makefile b/raster/r.colors/Makefile
index de53e51244b..7d691dbbc28 100644
--- a/raster/r.colors/Makefile
+++ b/raster/r.colors/Makefile
@@ -12,14 +12,18 @@ include $(MODULE_TOPDIR)/include/Make/Multi.make
default: multi thumbnails
-thumbnails: $(BIN)/r.mapcalc$(EXE) $(BIN)/r.colors$(EXE) $(HTMLDIR)/colortables
+thumbnails: $(BIN)/r.mapcalc$(EXE) $(BIN)/r.colors$(EXE) $(HTMLDIR)/colortables $(MDDIR)/source/colortables
ifndef CROSS_COMPILING
- -$(call run_grass, $(GRASS_HOME)/utils/thumbnails.py)
+ $(call run_grass, $(GRASS_HOME)/utils/thumbnails.py $(MDDIR)/source/colortables)
+ $(call run_grass, $(GRASS_HOME)/utils/thumbnails.py $(HTMLDIR)/colortables)
endif
$(HTMLDIR)/colortables: $(HTMLDIR)
$(MKDIR) $@
+$(MDDIR)/source/colortables: $(MDDIR)
+ $(MKDIR) $@
+
$(BIN)/r.mapcalc$(EXE):
$(MAKE) -C ../r.mapcalc
diff --git a/scripts/g.extension/g.extension.py b/scripts/g.extension/g.extension.py
index f694e73c23a..afa3f17a60c 100644
--- a/scripts/g.extension/g.extension.py
+++ b/scripts/g.extension/g.extension.py
@@ -1957,6 +1957,23 @@ def download_source_code(
return directory, url
+def create_md_if_missing(root_dir):
+ """Recursively searches for HTML files in the specified directory.
+ If an HTML file does not have a corresponding Markdown (.md) file,
+ it creates one by copying the HTML file and renaming it.
+ """
+ for dirpath, _, filenames in os.walk(root_dir):
+ html_files = [f for f in filenames if f.endswith(".html")]
+
+ for html_file in html_files:
+ md_file = os.path.splitext(html_file)[0] + ".md"
+ md_path = os.path.join(dirpath, md_file)
+
+ if not os.path.exists(md_path):
+ html_path = os.path.join(dirpath, html_file)
+ shutil.copy(html_path, md_path)
+
+
def install_extension_std_platforms(name, source, url, branch):
"""Install extension on standard platforms"""
gisbase = os.getenv("GISBASE")
@@ -1976,6 +1993,7 @@ def install_extension_std_platforms(name, source, url, branch):
tmpdir=TMPDIR,
branch=branch,
)
+ create_md_if_missing(srcdir)
os.chdir(srcdir)
pgm_not_found_message = _(
diff --git a/utils/mkdocs.py b/utils/mkdocs.py
index 1323fe06229..ecbca5f4a0f 100644
--- a/utils/mkdocs.py
+++ b/utils/mkdocs.py
@@ -1,14 +1,16 @@
# common functions used by mkmarkdown.py and mkhtml.py
-import sys
-import os
import json
-import subprocess
+import os
import re
+import shutil
+import subprocess
+import sys
+import tempfile
import urllib.parse as urlparse
+from datetime import datetime
from http import HTTPStatus
from pathlib import Path
-from datetime import datetime
from urllib import request as urlrequest
from urllib.error import HTTPError, URLError
@@ -368,68 +370,75 @@ def get_addon_path(base_url, pgm, major_version):
:return str|None: pgm path if pgm is addon else None
"""
addons_base_dir = os.getenv("GRASS_ADDON_BASE")
- if addons_base_dir and major_version:
- grass_addons_dir = Path(addons_base_dir) / "grass-addons"
- if gs:
- call = gs.call
- popen = gs.Popen
- fatal = gs.fatal
- else:
- call = subprocess.call
- popen = subprocess.Popen
- fatal = sys.stderr.write
- addons_branch = get_version_branch(
- major_version=major_version,
- addons_git_repo_url=urlparse.urljoin(base_url, "grass-addons/"),
- )
- if not Path(addons_base_dir).exists():
- Path(addons_base_dir).mkdir(parents=True, exist_ok=True)
- if not grass_addons_dir.exists():
- call(
- [
- "git",
- "clone",
- "-q",
- "--no-checkout",
- f"--branch={addons_branch}",
- "--filter=blob:none",
- urlparse.urljoin(base_url, "grass-addons/"),
- ],
- cwd=addons_base_dir,
- )
- addons_file_list = popen(
- ["git", "ls-tree", "--name-only", "-r", addons_branch],
- cwd=grass_addons_dir,
- stdout=subprocess.PIPE,
- stderr=subprocess.PIPE,
+ if not addons_base_dir or not major_version:
+ return None
+ grass_addons_dir = Path(addons_base_dir) / "grass-addons"
+ if gs:
+ call = gs.call
+ popen = gs.Popen
+ fatal = gs.fatal
+ else:
+ call = subprocess.call
+ popen = subprocess.Popen
+ fatal = sys.stderr.write
+ addons_branch = get_version_branch(
+ major_version=major_version,
+ addons_git_repo_url=urlparse.urljoin(base_url, "grass-addons/"),
+ )
+ if not Path(addons_base_dir).exists():
+ Path(addons_base_dir).mkdir(parents=True, exist_ok=True)
+ if not grass_addons_dir.exists():
+ try:
+ with tempfile.TemporaryDirectory(dir=addons_base_dir) as tmpdir:
+ tmp_clone_path = Path(tmpdir) / "grass-addons"
+ call(
+ [
+ "git",
+ "clone",
+ "-q",
+ "--no-checkout",
+ f"--branch={addons_branch}",
+ "--filter=blob:none",
+ urlparse.urljoin(base_url, "grass-addons/"),
+ str(tmp_clone_path),
+ ]
+ )
+ shutil.move(tmp_clone_path, grass_addons_dir)
+ except shutil.Error:
+ pass # Another process created it first; proceed normally
+ addons_file_list = popen(
+ ["git", "ls-tree", "--name-only", "-r", addons_branch],
+ cwd=grass_addons_dir,
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE,
+ )
+ addons_file_list, stderr = addons_file_list.communicate()
+ if stderr:
+ message = (
+ "Failed to get addons files list from the"
+ " Git repository <{repo_path}>.\n{error}"
)
- addons_file_list, stderr = addons_file_list.communicate()
- if stderr:
- message = (
- "Failed to get addons files list from the"
- " Git repository <{repo_path}>.\n{error}"
- )
- if gs:
- fatal(
- _(
- message,
- ).format(
- repo_path=grass_addons_dir,
- error=gs.decode(stderr),
- )
+ if gs:
+ fatal(
+ _(
+ message,
+ ).format(
+ repo_path=grass_addons_dir,
+ error=gs.decode(stderr),
)
- else:
- message += "\n"
- fatal(
- message.format(
- repo_path=grass_addons_dir,
- error=stderr.decode(),
- )
+ )
+ else:
+ message += "\n"
+ fatal(
+ message.format(
+ repo_path=grass_addons_dir,
+ error=stderr.decode(),
)
- addon_paths = re.findall(
- rf".*{pgm}*.",
- gs.decode(addons_file_list) if gs else addons_file_list.decode(),
- )
- for addon_path in addon_paths:
- if pgm == Path(addon_path).name:
- return addon_path
+ )
+ addon_paths = re.findall(
+ rf".*{pgm}*.",
+ gs.decode(addons_file_list) if gs else addons_file_list.decode(),
+ )
+ for addon_path in addon_paths:
+ if pgm == Path(addon_path).name:
+ return addon_path
diff --git a/utils/thumbnails.py b/utils/thumbnails.py
index b0197b712df..c04c806bb13 100755
--- a/utils/thumbnails.py
+++ b/utils/thumbnails.py
@@ -15,6 +15,7 @@
import os
import atexit
+import sys
from pathlib import Path
import grass.script as gs
@@ -106,7 +107,7 @@ def make_gradient(path):
def make_image(output_dir, table, grad, height, width):
- outfile = os.path.join(output_dir, "colortables", "%s.png" % table)
+ outfile = os.path.join(output_dir, "%s.png" % table)
os.environ["GRASS_RENDER_FILE"] = outfile
gs.run_command("r.colors", map=grad, color=table, quiet=True)
@@ -158,7 +159,7 @@ def main():
os.environ["GRASS_OVERWRITE"] = "1"
color_dir = os.path.join(os.environ["GISBASE"], "etc", "colors")
- output_dir = os.path.join(os.environ["GISBASE"], "docs", "html")
+ output_dir = sys.argv[1]
if not os.path.exists(output_dir):
os.makedirs(output_dir)