Merge pull request #185 from blairconrad/html-docs

Generate HTML documentation

Author: tummychow

.github/workflows/build.yml

@@ -56,3 +56,8 @@ jobs:
         with:
           path: Documentation/git-absorb.1
           name: git-absorb.1
+      - name: Upload HTML docs page as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          path: Documentation/git-absorb.html
+          name: git-absorb.html

.github/workflows/release.yml

@@ -78,6 +78,16 @@ jobs:
         with:
           name: ${{ needs.create-release.outputs.GA_VERSION }}
           files: Documentation/git-absorb.1
+      - name: Upload HTML docs as artifact
+        uses: actions/upload-artifact@v4
+        with:
+          path: Documentation/git-absorb.html
+          name: git-absorb.html
+      - name: Attach HTML docs to release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: ${{ needs.create-release.outputs.GA_VERSION }}
+          files: Documentation/git-absorb.html
 
   build-release:
     name: build-release
@@ -155,6 +165,12 @@ jobs:
           name: git-absorb.1
           path: Documentation
 
+      - name: Download HTML docs
+        uses: actions/download-artifact@v4
+        with:
+          name: git-absorb.html
+          path: Documentation
+
       - name: Build archive
         shell: bash
         run: |
@@ -163,7 +179,7 @@ jobs:
           mkdir -p "$staging"/doc
 
           cp {README.md,LICENSE.md} "$staging/"
-          cp Documentation/{git-absorb.1,git-absorb.adoc} "$staging/doc/"
+          cp Documentation/{git-absorb.1,git-absorb.html,git-absorb.adoc} "$staging/doc/"
 
           if [[ "${{ matrix.target }}" =~ .*windows.* ]]; then
             cp "target/${{ matrix.target }}/release/git-absorb.exe" "$staging/"

.gitignore

@@ -1,3 +1,4 @@
 /Documentation/git-absorb.1
+/Documentation/git-absorb.html
 /target/
 .idea

Documentation/Makefile

@@ -1,9 +1,15 @@
-build-manpage: git-absorb.1
+build-documentation: git-absorb.1 git-absorb.html
 
 git-absorb.1: git-absorb.adoc
 	$(if $(shell command -v a2x),,$(error "No a2x in PATH; install asciidoc."))
 	$(info Building manpage. This may take a few moments...)
 	a2x -L -d manpage -f manpage git-absorb.adoc --attribute man-version=${GA_VERSION}
 
+git-absorb.html: git-absorb.adoc
+	$(if $(shell command -v a2x),,$(error "No a2x in PATH; install asciidoc."))
+
+	$(info Building HTML docs. This may take a few moments...)
+	asciidoc -d manpage -b xhtml11 git-absorb.adoc
+
 clean:
 	rm -f git-absorb.1 git-absorb.xml

Documentation/README.md

@@ -1,13 +1,18 @@
 git-absorb manual
 =================
 
-This project's man page `git-absorb.1` can be generated from `git-absorb.adoc`
+This project's documentation can be generated from [git-absorb.adoc][] as
+
+* a man page (`git-absorb.1`) and
+* an HTML document (`git-absorb.html`)
+
 by running `make`.
 
 Build dependencies
 ------------------
 
-- [asciidoc][] (tested with version 8.6.10)
+- [asciidoc][] (tested with version 10.2.0)
 - GNU Make
 
-[asciidoc]: http://www.methods.co.nz/asciidoc/
+[asciidoc]: https://asciidoc.org/
+[git-absorb.adoc]: git-absorb.adoc