Rewrite manpages in Asciidoc (#262)

Author: straight-shoota

.circleci/config.yml

@@ -36,6 +36,17 @@ commands:
             - ~/Library/Caches/Homebrew
 
 jobs:
+  build-manpages:
+    docker:
+      - image: asciidoctor/docker-asciidoctor
+    steps:
+      - checkout
+      - run:
+          name: Build manpages
+          command: make manpages
+      - store_artifacts:
+          path: man
+
   test:
     docker:
       - image: crystallang/crystal:latest
@@ -63,6 +74,7 @@ workflows:
   version: 2
   ci:
     jobs:
+      - build-manpages
       - test
       - test-on-osx
       - test-on-nightly

.github/workflows/ci.yml

@@ -42,3 +42,13 @@ jobs:
 
       - name: Check formatting
         run: crystal tool format --check src spec
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download source
+        uses: actions/checkout@v2
+      - name: Build manpages
+        uses: Analog-inc/asciidoctor-action@master
+        with:
+          shellcommand: "make manpages"

.gitignore

@@ -7,3 +7,4 @@
 /spec/.shards
 /spec/unit/.lib
 /tmp
+/docs/*.html

Makefile

@@ -14,6 +14,7 @@ SOURCES = $(SHARDS_SOURCES) $(MOLINILLO_SOURCES)
 TEMPLATES = src/templates/*.ecr
 
 SHARDS_CONFIG_BUILD_COMMIT := $(shell git rev-parse --short HEAD 2> /dev/null)
+SHARDS_VERSION := $(shell cat VERSION)
 SOURCE_DATE_EPOCH := $(shell (git show -s --format=%ct HEAD || stat -c "%Y" Makefile || stat -f "%m" Makefile) 2> /dev/null)
 EXPORTS := SHARDS_CONFIG_BUILD_COMMIT="$(SHARDS_CONFIG_BUILD_COMMIT)" SOURCE_DATE_EPOCH="$(SOURCE_DATE_EPOCH)"
 DESTDIR ?=
@@ -27,14 +28,16 @@ MOLINILLO_URL = "https://github.com/crystal-lang/crystal-molinillo/archive/v$(MO
 
 all: bin/shards
 
-clean: phony
+include docs.mk
+
+clean: phony clean_docs
 	rm -f bin/shards
 
 bin/shards: $(SOURCES) $(TEMPLATES) lib
 	@mkdir -p bin
 	$(EXPORTS) $(CRYSTAL) build $(FLAGS) src/shards.cr -o bin/shards
 
-install: bin/shards phony
+install: bin/shards manpages phony
 	$(INSTALL) -m 0755 -d "$(BINDIR)" "$(MANDIR)/man1" "$(MANDIR)/man5"
 	$(INSTALL) -m 0755 bin/shards "$(BINDIR)"
 	$(INSTALL) -m 0644 man/shards.1 "$(MANDIR)/man1"

README.md

@@ -75,6 +75,10 @@ These requirements are only for compiling Shards.
   variable (eg: `export LIBRARY_PATH="/usr/local/lib:$LIBRARY_PATH"`).
   Please adjust the path per your Homebrew installation.
 
+* [asciidoctor](https://asciidoctor.org/)
+
+  Needed for building manpages.
+
 
 ## License