Skip to content

Commit

Permalink
fix documentation generation
Browse files Browse the repository at this point in the history
  • Loading branch information
fstamour committed Jul 21, 2024
1 parent 0c9a73f commit 14231b5
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 28 deletions.
26 changes: 6 additions & 20 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,38 +36,24 @@ test:
paths:
- public

## The job "doc" will re-run the tests, but I'm keeping that
## redundancy because the job "test" will be expanded to work on
## multiple cl implementations.

# Build public/ folder using org-publish on docs/
org-mode-publish:
doc:
image: docker:24.0.7
services:
- docker:24.0.5-dind
script:
- apk add --no-cache make
- make public
- mv public org-mode-publish
artifacts:
paths:
- org-mode-publish
- public
rules:
- when: manual

# Merge "test" and "org-mode-publish"'s outputs
doc:
needs:
- job: test
parallel:
matrix:
- STACK:
- sbcl
artifacts: true
- job: org-mode-publish
artifacts: true
script:
- cp org-mode-publish/* public/
artifacts:
paths:
- public

pages:
needs:
- job: doc
Expand Down
2 changes: 1 addition & 1 deletion docs/editor_integrations.org
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

* TODO Make sure the commands are executed against _common lisp_ code :ux:editor:

Gavinok tried breeze, but ran ~C-.~ on ~breeze.el~, this causes
Gavinok tried breeze, but ran ~C-.~ on ~breeze.el~, this caused
confusion for everybody.

Here's some ideas to help with this:
Expand Down
17 changes: 11 additions & 6 deletions makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@

# Run the unit tests
.PHONY: test
test:
scripts/test.sh

Expand All @@ -10,6 +11,7 @@ doc:

DOCKER_BUILD := DOCKER_BUILDKIT=1 docker build --progress=plain

.PHONY: build-within-container
build-within-container:
$(DOCKER_BUILD) --target=$(TARGET) --output type=local,dest=$(or $(DEST),.) . 2>&1 | tee $(TARGET).log

Expand All @@ -23,20 +25,23 @@ integration: TARGET=test
integration: DEST=public
integration: build-within-container dependencies.core

.PHONY: public
public: TARGET=public
public: DEST=public
public: build-within-container dependencies.core


# Run some "integration tests" that generates some screenshots
# This is work-in-progress
.PHONY: demo
demo:
scripts/demo/build-docker-image.sh

# Fix spelling
.PHONY: spell
spell:
codespell --write-changes --interactive 3 --ignore-words scripts/ignore-words.txt $$(fd -e lisp) README.md notes.org docs/*.md src/breeze.el

.PHONY: watch
watch:
( fd . -e lisp src/ tests/; echo breeze.asd ) | entr time scripts/test.sh

.PHONY: \
test \
demo \
spell \
watch
4 changes: 3 additions & 1 deletion scripts/org-publish-project.el
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,6 @@
:with-toc nil
)))
(org-id-update-id-locations (directory-files root t "\\.org$"))
(org-publish project-alist forcep))
(org-publish project-alist forcep)
(copy-file "docs/listing-breeze.html" "public/")
(copy-file "docs/style.css" "public/"))

0 comments on commit 14231b5

Please sign in to comment.