organize documentation

This commit is contained in:
Nick Chan 2023-02-06 16:33:14 +08:00
parent 4158d6a0aa
commit 020ebdb41c
6 changed files with 16 additions and 8 deletions

View File

@ -21,7 +21,7 @@ jobs:
run: |
make -j$(nproc) docs
mkdir ready
cp palera1n.1.html mandoc.css ready
cp docs/*.html docs/mandoc.css ready
- name: Upload artifact
uses: wangyucode/sftp-upload-action@v1.4.8

3
.gitignore vendored
View File

@ -8,7 +8,6 @@ contrib/
checkra1n*
payload.c
src/palera1n
palera1n*
!xxd-embedded.h
src/binpack.dmg
src/ramdisk.dmg
@ -16,3 +15,5 @@ src/xxd-*.c
.DS_Store
!palera1n.1
palera1n.1.html
Payload
docs/*.html

View File

@ -54,18 +54,16 @@ palera1n: download-deps
clean:
$(MAKE) -C src clean
rm palera1n.1.html
$(MAKE) -C docs clean
download-deps:
$(MAKE) -C src checkra1n-macos checkra1n-linux-arm64 checkra1n-linux-armel checkra1n-linux-x86 checkra1n-linux-x86_64 checkra1n-kpf-pongo ramdisk.dmg binpack.dmg
palera1n.1.html: palera1n.1
mandoc -T html -O style=mandoc.css palera1n.1 > palera1n.1.html
docs: palera1n.1.html
docs:
$(MAKE) -C docs
distclean: clean
rm -rf palera1n-* palera1n*.dSYM src/checkra1n-* src/checkra1n-kpf-pongo src/ramdisk.dmg src/binpack.dmg
.PHONY: all palera1n clean
.PHONY: all palera1n clean docs distclean

9
docs/Makefile Normal file
View File

@ -0,0 +1,9 @@
PAGES = palera1n.1.html
all: $(PAGES)
%.1.html: %.1
mandoc -T html -O style=mandoc.css palera1n.1 > palera1n.1.html
clean:
rm -f $(PAGES)