From f3970e48d86dee8ef19becf95821580914a0db05 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 23 Sep 2024 12:11:53 +0000 Subject: [PATCH] Update docs --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d42ee05..078f928 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](d011) `docs-builder:build` system &rest rest &key (error-on-warnings t) &allow-other-keys +#### [function](7024) `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](a50d) `docs-builder/guesser:guess-builder` system +#### [generic-function](e3b1) `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](2958) `docs-builder/builder:build` builder system &key local root-sections &allow-other-keys +#### [generic-function](0e92) `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](962e) `docs-config:docs-config` asdf-system +#### [generic-function](3008) `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 -[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 +[0e92]: https://github.com/40ants/docs-builder/blob/9ce5909451997d53ae6f6b0a11648a872a5323b8/src/builder.lisp#L10 +[3008]: https://github.com/40ants/docs-builder/blob/9ce5909451997d53ae6f6b0a11648a872a5323b8/src/config.lisp#L9 +[7024]: https://github.com/40ants/docs-builder/blob/9ce5909451997d53ae6f6b0a11648a872a5323b8/src/core.lisp#L29 +[e3b1]: https://github.com/40ants/docs-builder/blob/9ce5909451997d53ae6f6b0a11648a872a5323b8/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