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

doc: Document and fix lake config changes with -R

main
Henrik Böving 2023-11-18 22:04:42 +01:00
parent 2ba3e84eca
commit ca82b428ed
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -11,18 +11,19 @@ require «doc-gen4» from git "https://github.com/leanprover/doc-gen4" @ "main"
Then update your dependencies: Then update your dependencies:
``` ```
lake -Kenv=dev update lake -R -Kenv=dev update
``` ```
Then you can generate documentation for an entire library and all files imported Then you can generate documentation for an entire library and all files imported
by that library using: by that library using:
``` ```
lake -Kenv=dev build Test:docs lake -R -Kenv=dev build Test:docs
``` ```
If you have multiple libraries you want to generate full documentation for: If you have multiple libraries you want to generate full documentation for:
``` ```
lake -Kenv=dev build Test:docs Foo:docs 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.

4
test_docs.sh
View File

@ -9,5 +9,5 @@ set -x
cd "$1" cd "$1"
sed -i "s|from git \"https://github.com/leanprover/doc-gen4\" @ \"main\"| from \"..\" / \"doc-gen4\" with NameMap.empty|" lakefile.lean sed -i "s|from git \"https://github.com/leanprover/doc-gen4\" @ \"main\"| from \"..\" / \"doc-gen4\" with NameMap.empty|" lakefile.lean
lake -Kdoc=on update lake -R -Kdoc=on update
lake -Kdoc=on build Std:docs lake -R -Kdoc=on build Std:docs