Skip to content

doc: Markdown to man conversion #5358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
petrasovaa wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

doc: Markdown to man conversion #5358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
025781d
doc: markdown to man pages
petrasovaa Mar 7, 2025
9db21fe
doc: markdown to man pages
petrasovaa Mar 7, 2025
a64b969
update converter
petrasovaa Mar 11, 2025
e3b0d89
switch to generating man pages from markdown
petrasovaa Mar 11, 2025
f50b136
fix whitespace
petrasovaa Mar 11, 2025
50f532d
fix build
petrasovaa Mar 11, 2025
de65005
Update utils/markdown2man.py
petrasovaa Mar 12, 2025
54a8436
Merge branch 'main' into markdown-to-man
petrasovaa Jul 25, 2025
75a4b43
fixes
petrasovaa Jul 25, 2025
5d4840f
fix tables and lists
petrasovaa Jul 28, 2025
1b7b12d
continued fixes
petrasovaa Jul 30, 2025
45eda12
resolve conflict
petrasovaa Jul 30, 2025
8c03213
fix
petrasovaa Jul 31, 2025
4535e9c
Merge branch 'main' into markdown-to-man
echoix Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,8 +218,8 @@ include(generate_html)

set(MKHTML_PY ${CMAKE_BINARY_DIR}/utils/mkhtml.py)
set(THUMBNAILS_PY ${CMAKE_BINARY_DIR}/utils/thumbnails.py)
set(HTML2MAN VERSION_NUMBER=${GRASS_VERSION_NUMBER} ${PYTHON_EXECUTABLE}
${OUTDIR}/${GRASS_INSTALL_UTILSDIR}/g.html2man.py)
set(MD2MAN VERSION_NUMBER=${GRASS_VERSION_NUMBER} ${PYTHON_EXECUTABLE}
${OUTDIR}/${GRASS_INSTALL_UTILSDIR}/markdown2man.py)

set(env_path "$ENV{PATH}")

Expand Down
8 changes: 4 additions & 4 deletions cmake/generate_man_pages.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# work in progress...


file(GLOB doc_HTMLFILES "${OUTDIR}/${GRASS_INSTALL_DOCDIR}/*.html")
file(GLOB doc_MDFILES "${OUTDIR}/${GRASS_INSTALL_MKDOCSDIR}/source/*.md")

foreach(html_file ${doc_HTMLFILES})
get_filename_component(PGM_NAME ${html_file} NAME)
foreach(md_file ${doc_MDFILES})
get_filename_component(PGM_NAME ${md_file} NAME)
add_custom_command(
TARGET create_man_pages
PRE_BUILD
COMMAND ${HTML2MAN} ${OUTDIR}/${GRASS_INSTALL_DOCDIR}/${PGM_NAME}.html
COMMAND ${MD2MAN} ${OUTDIR}/${GRASS_INSTALL_MKDOCSDIR}/${PGM_NAME}.html
${OUTDIR}/${GRASS_INSTALL_MANDIR}/${PGM_NAME}.1
)
endforeach()
Expand Down
2 changes: 1 addition & 1 deletion include/Make/Grass.make
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ YFLAGS = -d -v
MANSECT = 1
MANBASEDIR = $(ARCH_DISTDIR)/docs/man
MANDIR = $(MANBASEDIR)/man$(MANSECT)
HTML2MAN = VERSION_NUMBER=$(GRASS_VERSION_NUMBER) $(GISBASE)/utils/g.html2man.py
MD2MAN = VERSION_NUMBER=$(GRASS_VERSION_NUMBER) $(GISBASE)/utils/markdown2man.py

GDAL_LINK = $(USE_GDAL)

Expand Down
4 changes: 2 additions & 2 deletions include/Make/Html.make
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ $(MDDIR)/source/%.md: %.md %.tmp.md $(HTMLSRC) $(IMGDST_MD) | $(MDDIR)
VERSION_NUMBER=$(GRASS_VERSION_NUMBER) VERSION_DATE=$(GRASS_VERSION_DATE) MODULE_TOPDIR=$(MODULE_TOPDIR) \
$(PYTHON) $(GISBASE)/utils/mkmarkdown.py $* > $@

$(MANDIR)/%.$(MANSECT): $(HTMLDIR)/%.html
$(HTML2MAN) "$<" "$@"
$(MANDIR)/%.$(MANSECT): $(MDDIR)/source/%.md
$(MD2MAN) "$<" "$@"

%.tmp.html: $(HTMLSRC)
if [ "$(HTMLSRC)" != "" ] ; then $(call htmldesc,$<,$@) ; fi
Expand Down
2 changes: 1 addition & 1 deletion man/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ default: $(DSTFILES)
@echo "Generating manual pages index (help system)..."
$(MAKE) $(INDICES)
$(call build,check)
$(MAKE) manpages
$(MAKE) $(INDICES_MD)
$(MAKE) manpages
# $(MAKE) build-mkdocs

# This must be a separate target so that evaluation of $(MANPAGES)
Expand Down
4 changes: 4 additions & 0 deletions utils/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ include $(MODULE_TOPDIR)/include/Make/Compile.make

default: parsubdirs $(UTILSDIR)/mkdocs.py $(UTILSDIR)/mkhtml.py $(UTILSDIR)/mkmarkdown.py \
$(UTILSDIR)/generate_last_commit_file.py \
$(UTILSDIR)/markdown2man.py \
$(UTILSDIR)/g.echo$(EXE)

$(UTILSDIR)/mkdocs.py: mkdocs.py
Expand All @@ -21,5 +22,8 @@ $(UTILSDIR)/mkmarkdown.py: mkmarkdown.py
$(UTILSDIR)/generate_last_commit_file.py: generate_last_commit_file.py
$(INSTALL) $< $@

$(UTILSDIR)/markdown2man.py: markdown2man.py
$(INSTALL) $< $@

$(UTILSDIR)/g.echo$(EXE): $(OBJDIR)/g.echo.o
$(call linker_base,$(LINK),$(LDFLAGS) $(EXTRA_LDFLAGS),$(MANIFEST_OBJ))
Loading
Loading