From 68ab8e8b0a6bea73300dc682c6510aca6a8d5821 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 11 Mar 2024 18:58:17 +0000 Subject: [PATCH] Update docs --- ChangeLog.md | 6 ++++++ README.md | 16 ++++++++-------- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/ChangeLog.md b/ChangeLog.md index f6b49db..1363511 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -2,6 +2,12 @@ # ChangeLog + + +## 0.11.1 (2024-03-11) + +* Fixed initite loop when the system is unknown to `ASDF` yet. + ## 0.11.0 (2023-06-05) diff --git a/README.md b/README.md index 890e749..d42ee05 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ From the `REPL`, you need first to call a [`docs-builder:build`][febf] function: -#### [function](ef91) `docs-builder:build` system &rest rest &key (error-on-warnings t) &allow-other-keys +#### [function](d011) `docs-builder:build` system &rest rest &key (error-on-warnings t) &allow-other-keys Builds `HTML` documentation for `ASDF` system and returns absolute path to the dir with docs. @@ -53,7 +53,7 @@ Inside, it will try to guess which documentation builder should be used: -#### [generic-function](1e54) `docs-builder/guesser:guess-builder` system +#### [generic-function](a50d) `docs-builder/guesser:guess-builder` system Returns a builder object which can be passed to the [`docs-builder/builder:build`][9de0] generic-function along with system. @@ -65,7 +65,7 @@ Then it will pass the builder object and `ASDF` system to the [`docs-builder/bui -#### [generic-function](d4ae) `docs-builder/builder:build` builder system &key local root-sections &allow-other-keys +#### [generic-function](2958) `docs-builder/builder:build` builder system &key local root-sections &allow-other-keys Builds `HTML` documentation for `ASDF` system and returns absolute path to the dir with docs. @@ -154,7 +154,7 @@ You can customize a builder by defining a method for this generic function: -#### [generic-function](f007) `docs-config:docs-config` asdf-system +#### [generic-function](962e) `docs-config:docs-config` asdf-system Should return a plist which will be passed as keyword arguments to the documentation builder when building @@ -215,10 +215,10 @@ a method looks like when I configure Weblocks documentation builder: [8884]: https://cl-doc-systems.github.io/ [843b]: https://github.com/40ants/docs-builder [100b]: https://github.com/40ants/docs-builder/actions -[d4ae]: https://github.com/40ants/docs-builder/blob/dffb6b97a9fc69784616aa3dd23511f977d9b27b/src/builder.lisp#L10 -[f007]: https://github.com/40ants/docs-builder/blob/dffb6b97a9fc69784616aa3dd23511f977d9b27b/src/config.lisp#L9 -[ef91]: https://github.com/40ants/docs-builder/blob/dffb6b97a9fc69784616aa3dd23511f977d9b27b/src/core.lisp#L29 -[1e54]: https://github.com/40ants/docs-builder/blob/dffb6b97a9fc69784616aa3dd23511f977d9b27b/src/guesser.lisp#L14 +[2958]: https://github.com/40ants/docs-builder/blob/d6cb351211c909fd937fcca194b4de8c2d4845a7/src/builder.lisp#L10 +[962e]: https://github.com/40ants/docs-builder/blob/d6cb351211c909fd937fcca194b4de8c2d4845a7/src/config.lisp#L9 +[d011]: https://github.com/40ants/docs-builder/blob/d6cb351211c909fd937fcca194b4de8c2d4845a7/src/core.lisp#L29 +[a50d]: https://github.com/40ants/docs-builder/blob/d6cb351211c909fd937fcca194b4de8c2d4845a7/src/guesser.lisp#L14 [7d71]: https://github.com/40ants/docs-builder/issues [7927]: https://github.com/melisgl/mgl-pax [795a]: https://github.com/roswell/roswell