Merge pull request #38 from ryukinix/auto-docs

docs: add make docs

Author: ryukinix

.github/workflows/docs.yml

@@ -0,0 +1,19 @@
+name: Docs
+
+on: workflow_dispatch
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build docs using docker
+        run: make docker-docs
+
+      - name: Publish docs to gh-pages
+        run: make docs-publish

.gitignore

@@ -1,3 +1,4 @@
 *.fasl
 system-index.txt
 lisp-inference
+docs/

Makefile

@@ -18,16 +18,29 @@ check:
 server:
 	@$(SBCL_CMD) run-server.lisp
 
+docs-worktree:
+	@if [ ! -d docs ]; then \
+		git worktree add docs gh-pages -f; \
+    fi
+
+docs: docs-worktree
+	@$(SBCL_CMD) run-docs.lisp
+
+docs-publish:
+	cd docs/ && git add . && git commit -m "Auto-generated commit from make docs-publish" && git push || true
+
 docker-build:
 	docker build -t $(DOCKER_IMG) .
 
 docker-shell: docker-build
 	docker run --rm -it --entrypoint=/bin/bash $(DOCKER_IMG)
 
-
 docker-run: docker-build
 	docker run --rm -it --network=host $(DOCKER_IMG)
 
+docker-docs: docker-build docs-worktree
+	docker run --rm -t -v $(PWD)/docs:/root/.roswell/local-projects/local/lisp-inference/docs --entrypoint=ros $(DOCKER_IMG) run -l run-docs.lisp
+
 docker-check: docker-build
 	docker run --rm -t --entrypoint=ros $(DOCKER_IMG) run -l run-test.lisp
 
@@ -38,4 +51,4 @@ docker-publish: docker-build
 deploy: docker-publish
 	ssh starfox bash /home/lerax/Deploy/logic.sh
 
-.PHONY: check docker-build
+.PHONY: check docker-build docs

lisp-inference.asd

@@ -8,7 +8,8 @@
   :description "An Inference Engine using Propositional Calculus"
   :author "Manoel Vilela <[email protected]>"
   :license "BSD"
-  :version "0.2.0"
+  :version "0.4.0"
+  :homepage "https://github.com/ryukinix/lisp-inference"
   :serial t
   :pathname "src"
   :components ((:file "package")
@@ -26,7 +27,8 @@
   :description "An web interface for Lisp Inference Truth Table"
   :author "Manoel Vilela <[email protected]>"
   :license "BSD"
-  :version "0.2.0"
+  :version "0.4.0"
+  :homepage "https://github.com/ryukinix/lisp-inference"
   :serial t
   :depends-on (:lisp-inference
                :40ants-routes ;; implicit dependency of reblocks
@@ -42,7 +44,8 @@
   :description "Lisp Inference Tests"
   :author "Manoel Vilela <[email protected]>"
   :license "BSD"
-  :version "0.2.0"
+  :version "0.4.0"
+  :homepage "https://github.com/ryukinix/lisp-inference"
   :serial t
   :pathname "t"
   :depends-on (:lisp-inference :rove)

run-docs.lisp

@@ -0,0 +1,7 @@
+(load "fix-quicklisp")
+;; auto generate docs with staple
+(ql:quickload '(:staple :lisp-inference :lisp-inference/tests :lisp-inference/web) :silent t)
+
+(staple:generate :lisp-inference :if-exists :overwrite)
+(format t "Docs generated at docs/ directory.~%")
+(sb-ext:exit :code 0)

src/pratt.lisp

@@ -73,6 +73,7 @@
 
 ;; entrypoint
 (defun parse-logic (input)
+  "PARSE-LOGIC receive a INPUT as string and use a pratt parser to convert in infix notation"
   (setf *tokens* (tokenize input)
         *pos* 0)
   (parse-expression))

web/webapp.lisp

@@ -30,6 +30,7 @@
 (defvar *port* (find-port:find-port))
 (defvar *notes*
   '("Please, don't be evil. Use less than 10 variables."
+    "Use spaces around operators. Use 'p ^ q' instead 'p^q'."
     "Yes, [+] it's a XOR. Mathematically: p ⊕ q."
     "(=> ->) and (<=> <->) are aliases."))
 
@@ -125,7 +126,7 @@ history.pushState(null, '', url);
     (:br)
     (:span "Documentation: "
            (:a :href
-               "https://lerax.me/lisp-inference" "lerax.me/lisp-inference"))))
+               "https://manoel.dev/lisp-inference" "manoel.dev/lisp-inference"))))
 
 (defun render-note (string)
   (reblocks/html:with-html ()