r
/
bookshelf-doc
mirror of https://github.com/jrpotter/bookshelf-doc
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix: lake changed the build directory

main
Henrik Böving 2023-11-18 22:13:54 +01:00
parent ca82b428ed
commit b85fd6cbeb
5 changed files with 50 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -1,3 +1,3 @@
/build /.lake/*
/lake-packages/* /lake-packages/*
lakefile.olean lakefile.olean

2
DocGen4/Output/Base.lean
View File

@ -11,7 +11,7 @@ namespace DocGen4.Output
open scoped DocGen4.Jsx open scoped DocGen4.Jsx
open Lean System Widget Elab Process open Lean System Widget Elab Process
def basePath := FilePath.mk "." / "build" / "doc" def basePath := FilePath.mk "." / ".lake" / "build" / "doc"
def srcBasePath := basePath / "src" def srcBasePath := basePath / "src"
def declarationsBasePath := basePath / "declarations" def declarationsBasePath := basePath / "declarations"

14
README.md
View File

@ -27,11 +27,16 @@ lake -R -Kenv=dev build Test:docs Foo:docs
Note that `doc-gen4` currently always generates documentation for `Lean`, `Init` Note that `doc-gen4` currently always generates documentation for `Lean`, `Init`
and `Lake` in addition to the provided targets. and `Lake` in addition to the provided targets.
The root of the built docs will be `.lake/build/docs/index.html`. However, due to the "Same Origin Policy", the
generated website will be partially broken if you just open the generated html files in your browser. You
need to serve them from a proper http server for it to work. An easy way to do that is to run
`python3 -m http.server` from the `.lake/build/docs` directory.
## Assumptions that `doc-gen4` makes ## Assumptions that `doc-gen4` makes
The only requirement for the `lake -Kenv=dev build Test:docs` to work is that your The only requirement for the `lake -Kenv=dev build Test:docs` to work is that your
target library builds, that is `lake build Test` exits without an error. If this requirement target library builds, that is `lake build Test` exits without an error. If this requirement
is not fulfilled, the documentation generation will fail and you will end up with is not fulfilled, the documentation generation will fail and you will end up with
partial build artefacts in `build/doc`. Note that `doc-gen4` is perfectly capable of partial build artefacts in `.lake/build/doc`. Note that `doc-gen4` is perfectly capable of
generating documentation for Lean code that contains `sorry`, just not for code generating documentation for Lean code that contains `sorry`, just not for code
that doesn't compile. that doesn't compile.
@ -62,12 +67,7 @@ meta if get_config? env = some "dev" then -- dev is so not everyone has to build
require «doc-gen4» from "../doc-gen4" require «doc-gen4» from "../doc-gen4"
``` ```
The root of the built docs will be `build/docs/index.html`. However, due to the "Same Origin Policy", the
generated website will be partially broken if you just open the generated html files in your browser. You
need to serve them from a proper http server for it to work. An easy way to do that is to run
`python3 -m http.server` from the `build/docs` directory.
Note that if you modify the `.js` or `.css` files in `doc-gen4`, they won't necessarily be copied over when Note that if you modify the `.js` or `.css` files in `doc-gen4`, they won't necessarily be copied over when
you rebuild the documentation. You can manually copy the changes to the `build/docs` directory to make you rebuild the documentation. You can manually copy the changes to the `.lake/build/docs` directory to make
sure the changes appear, or just do a full recompilation (`lake clean` and `lake build` inside the `doc-gen4` sure the changes appear, or just do a full recompilation (`lake clean` and `lake build` inside the `doc-gen4`
directory.) directory.)

55
lake-manifest.json
View File

@ -1,36 +1,41 @@
{"version": 6, {"version": 7,
"packagesDir": "lake-packages", "packagesDir": ".lake/packages",
"packages": "packages":
[{"git": [{"url": "https://github.com/xubaiw/CMark.lean",
{"url": "https://github.com/xubaiw/CMark.lean", "type": "git",
"subDir?": null, "subDir": null,
"rev": "0077cbbaa92abf855fc1c0413e158ffd8195ec77", "rev": "0077cbbaa92abf855fc1c0413e158ffd8195ec77",
"opts": {},
"name": "CMark", "name": "CMark",
"inputRev?": "main", "manifestFile": "lake-manifest.json",
"inherited": false}}, "inputRev": "main",
{"git": "inherited": false,
"configFile": "lakefile.lean"},
{"url": "https://github.com/fgdorais/lean4-unicode-basic", {"url": "https://github.com/fgdorais/lean4-unicode-basic",
"subDir?": null, "type": "git",
"rev": "4ecf4f1f98d14d03a9e84fa1c082630fa69df88b", "subDir": null,
"opts": {}, "rev": "280d75fdfe7be8eb337be7f1bf8479b4aac09f71",
"name": "UnicodeBasic", "name": "UnicodeBasic",
"inputRev?": "main", "manifestFile": "lake-manifest.json",
"inherited": false}}, "inputRev": "main",
{"git": "inherited": false,
"configFile": "lakefile.lean"},
{"url": "https://github.com/mhuisi/lean4-cli", {"url": "https://github.com/mhuisi/lean4-cli",
"subDir?": null, "type": "git",
"subDir": null,
"rev": "39229f3630d734af7d9cfb5937ddc6b41d3aa6aa", "rev": "39229f3630d734af7d9cfb5937ddc6b41d3aa6aa",
"opts": {},
"name": "Cli", "name": "Cli",
"inputRev?": "nightly", "manifestFile": "lake-manifest.json",
"inherited": false}}, "inputRev": "nightly",
{"git": "inherited": false,
"configFile": "lakefile.lean"},
{"url": "https://github.com/hargonix/LeanInk", {"url": "https://github.com/hargonix/LeanInk",
"subDir?": null, "type": "git",
"subDir": null,
"rev": "2447df5cc6e48eb965c3c3fba87e46d353b5e9f1", "rev": "2447df5cc6e48eb965c3c3fba87e46d353b5e9f1",
"opts": {},
"name": "leanInk", "name": "leanInk",
"inputRev?": "doc-gen", "manifestFile": "lake-manifest.json",
"inherited": false}}], "inputRev": "doc-gen",
"name": "«doc-gen4»"} "inherited": false,
"configFile": "lakefile.lean"}],
"name": "«doc-gen4»",
"lakeDir": ".lake"}

2
lean-toolchain
View File

@ -1 +1 @@
leanprover/lean4:v4.2.0-rc4 leanprover/lean4:v4.3.0-rc2