make HTML build parallel

Author: koron

.github/workflows/build-and-deploy.yml

@@ -29,7 +29,7 @@ jobs:
 
       - name: Generate new HTML documents
         run: |
-          make html
+          make -j4 html
 
       - name: Check commit IDs
         id: commitid

Makefile

@@ -1,32 +1,50 @@
 .PHONY: all html clean
 
-JEKYLL_WORKDIR=target/jekyll-work
-JEKYLL_OUTDIR=target/_site
-
-html-prepare: vim/runtime/doc vim_faq/doc target/html/doc
-	rm -f target/html/doc/*.txt
-	cp vim/runtime/doc/*.txt target/html/doc
-	cp vim_faq/doc/*.txt target/html/doc
+VIM_ALL_TEXT = $(wildcard vim/runtime/doc/*.txt)
+SRC_TEXT = $(VIM_ALL_TEXT:vim/runtime/doc/%=target/html/doc/%) \
+	target/html/doc/tags.txt \
+	target/html/doc/vim_faq.txt
+DST_HTML = $(SRC_TEXT:%.txt=%.html)
 
-html: html-prepare
-	-cd target/html/doc ; vim -eu ../../../tools/buildhtml.vim -c "qall!"
+html: $(DST_HTML)
+	@echo completed to generate HTML files
 
-vim/runtime/doc:
+vim:
 	git clone --depth=1 https://github.com/vim/vim.git
 	cd vim && git apply ../tools/add-vimfaq-link.diff
 
-vim_faq/doc:
+vim/runtime/doc/%.txt: vim
+
+vim_faq:
 	git clone --depth=1 https://github.com/chrisbra/vim_faq.git
 
+vim_faq/doc/vim_faq.txt: vim_faq
+
 target/html/doc:
 	mkdir -p $@
 
+target/html/doc/tags target/html/doc/tags.txt: $(SRC_TEXT)
+	-cd target/html/doc && vim -esu ../../../tools/build_tag.vim -c "qall!"
+
+target/html/doc/%.txt: vim/runtime/doc/%.txt target/html/doc
+	cp $< $@
+
+target/html/doc/vim_faq.txt: vim_faq/doc/vim_faq.txt target/html/doc
+	cp $< $@
+
+# referenced by $(DST_HTML)
+target/html/doc/%.html: target/html/doc/%.txt target/html/doc/tags
+	-cd target/html/doc && vim -esu ../../../tools/build_html.vim -c "call VimdocEnConvert() | wqall!" $(<F)
+
 clean:
 	rm -rf target
 
 distclean:
 	rm -rf vim vim_faq
 
+JEKYLL_WORKDIR=target/jekyll-work
+JEKYLL_OUTDIR=target/_site
+
 jekyll-build-prepare:
 	mkdir -p $(JEKYLL_WORKDIR)
 	cp target/html/doc/*.html $(JEKYLL_WORKDIR)

tools/build_html.vim

@@ -0,0 +1,51 @@
+set nocompatible
+set nomore
+set encoding=utf-8
+set fileencodings=utf-8
+syntax on
+colorscheme delek
+let g:html_no_progress = 1
+
+source <sfile>:h/tag_aliases.vim
+source <sfile>:h/makehtml.vim
+
+let s:tools_dir = expand('<sfile>:p:h')
+let s:proj_dir = expand('<sfile>:p:h:h')
+
+function! s:ToJekyll()
+  let helpname = expand('%:t:r')
+  if helpname == 'index'
+    let helpname = 'help'
+  endif
+  " remove header
+  silent 1,/^<hr>/delete _
+  " remove footer
+  silent /^<hr>/,$delete _
+  " escape jekyll tags
+  silent %s/{\{2,}\|{%/{{ "\0" }}/ge
+  " YAML front matter
+  call append(0, [
+        \ '---',
+        \ 'layout: vimdoc',
+        \ printf("helpname: '%s'", helpname),
+        \ '---',
+        \ ])
+endfunction
+
+" Convert Vim's dodcument in current bufffer to HTML.
+function VimdocEnConvert()
+  set foldlevel=1000
+  " for the lastest help syntax
+  let &runtimepath = s:tools_dir . ',' . &runtimepath
+  " for ja custom syntax
+  let &runtimepath .= ',' . s:proj_dir
+
+  let dst = expand("%:r") . ".html"
+
+  call MakeHtml3("", 1)
+
+  silent f! `=dst`
+
+  set fileformat=unix
+  call s:ToJekyll()
+endfunction

tools/build_tag.vim

@@ -0,0 +1,14 @@
+set nocompatible
+set nomore
+set encoding=utf-8
+set fileencodings=utf-8
+
+try
+  helptags .
+catch
+  echo v:exception
+endtry
+
+source <sfile>:h/makehtml.vim
+
+call MakeTagsFile()

tools/makehtml.vim

@@ -74,7 +74,12 @@ endfunction
 
 function! MakeHtml2(src, dst, conceal)
   silent new `=a:src`
+  call MakeHtml3(s:GetLang(a:src), a:conceal)
+  silent wq! `=a:dst`
+endfunction
 
+" Generate HTML from the current buffer's contents
+function! MakeHtml3(lang, conceal)
   " 2html options
   let g:html_use_css = 1
   let g:html_no_pre = 1
@@ -90,8 +95,7 @@ function! MakeHtml2(src, dst, conceal)
   silent! %foldopen!
   silent! call tohtml#Convert2HTML(1, line('$'))
 
-  let lang = s:GetLang(a:src)
-  silent %s@<span class="\(helpHyperTextEntry\|helpHyperTextJump\|helpOption\|helpCommand\)">\([^<]*\)</span>@\=s:MakeLink(lang, submatch(1), submatch(2), a:conceal)@ge
+  silent %s@<span class="\(helpHyperTextEntry\|helpHyperTextJump\|helpOption\|helpCommand\)">\([^<]*\)</span>@\=s:MakeLink(a:lang, submatch(1), submatch(2), a:conceal)@ge
   silent %s@^<span class="Ignore">&lt;</span>\ze&nbsp;@\&nbsp;@ge
   silent %s@<span class="\(helpStar\|helpBar\|Ignore\)">[^<]*</span>@@ge
   call s:TranslateHelpExampleBlock()
@@ -100,8 +104,6 @@ function! MakeHtml2(src, dst, conceal)
 
   call s:Header()
   call s:Footer()
-
-  silent wq! `=a:dst`
 endfunction
 
 " <span>...</span>  -> <div>...