feat: update CI and README
parent
be3caa9e1a
commit
898496ca51
|
@ -25,6 +25,14 @@ jobs:
|
||||||
run: |
|
run: |
|
||||||
lake build
|
lake build
|
||||||
|
|
||||||
|
- name: Checkout and compile LeanInk
|
||||||
|
run: |
|
||||||
|
cd ../
|
||||||
|
git clone https://github.com/hargonix/LeanInk
|
||||||
|
cd LeanInk
|
||||||
|
git checkout doc-gen
|
||||||
|
lake build
|
||||||
|
|
||||||
- name: Checkout and compile mathlib4
|
- name: Checkout and compile mathlib4
|
||||||
run: |
|
run: |
|
||||||
cd ../
|
cd ../
|
||||||
|
@ -40,7 +48,7 @@ jobs:
|
||||||
deploy="false"
|
deploy="false"
|
||||||
fi
|
fi
|
||||||
cd ../
|
cd ../
|
||||||
./doc-gen4/deploy_docs.sh "mathlib4" "doc-gen4" "$deploy"
|
./doc-gen4/deploy_docs.sh "mathlib4" "doc-gen4" "$deploy" "LeanInk"
|
||||||
env:
|
env:
|
||||||
MATHLIB4_DOCS_KEY: ${{ secrets.MATHLIB4_DOCS_KEY }}
|
MATHLIB4_DOCS_KEY: ${{ secrets.MATHLIB4_DOCS_KEY }}
|
||||||
github_repo: ${{ github.repository }}
|
github_repo: ${{ github.repository }}
|
||||||
|
|
|
@ -10,6 +10,10 @@ $ /path/to/doc-gen4 Module
|
||||||
where `Module` is one or more of the top level modules you want to document.
|
where `Module` is one or more of the top level modules you want to document.
|
||||||
The tool will then proceed to compile the project using lake (if that hasn't happened yet),
|
The tool will then proceed to compile the project using lake (if that hasn't happened yet),
|
||||||
analyze it and put the result in `./build/doc`.
|
analyze it and put the result in `./build/doc`.
|
||||||
|
|
||||||
|
You can optionally provide the path to a `LeanInk` binary using the `--ink` flag which will make
|
||||||
|
the tool produce `Alectryon` style rendered output along the usual documentation.
|
||||||
|
|
||||||
You could e.g. host the files locally with the built-in Python webserver:
|
You could e.g. host the files locally with the built-in Python webserver:
|
||||||
```sh
|
```sh
|
||||||
$ cd build/doc && python -m http.server
|
$ cd build/doc && python -m http.server
|
||||||
|
|
|
@ -23,7 +23,7 @@ fi
|
||||||
|
|
||||||
# generate the docs
|
# generate the docs
|
||||||
cd $1
|
cd $1
|
||||||
../$2/build/bin/doc-gen4 Mathlib
|
../$2/build/bin/doc-gen4 --ink ../$4/build/bin/leanInk Mathlib
|
||||||
|
|
||||||
if [ "$3" = "true" ]; then
|
if [ "$3" = "true" ]; then
|
||||||
cd ..
|
cd ..
|
||||||
|
|
Loading…
Reference in New Issue