From 9857a395f193754094e921b35119d6b26ac2ae74 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Mon, 20 Oct 2025 14:57:10 +0200 Subject: [PATCH] docs: add docs for clanLib --- docs/.gitignore | 1 + docs/mkdocs.yml | 1 + docs/site/reference/clanLib/index.md | 18 ++++++++++++++++++ 3 files changed, 20 insertions(+) create mode 100644 docs/site/reference/clanLib/index.md diff --git a/docs/.gitignore b/docs/.gitignore index 2cb144263..379482152 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,5 @@ /site/reference +!/site/reference/clanLib/index.md /site/services/official /site/static /site/option-search diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9743be9e0..cabb6e332 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -140,6 +140,7 @@ nav: - reference/cli/vars.md - reference/cli/vms.md + - clanLib: reference/clanLib/index.md - HTTP API: api.md - Decisions: diff --git a/docs/site/reference/clanLib/index.md b/docs/site/reference/clanLib/index.md new file mode 100644 index 000000000..42fead25a --- /dev/null +++ b/docs/site/reference/clanLib/index.md @@ -0,0 +1,18 @@ +`clanLib` is a collection of functions and utilities + +!!! Danger + unless explicitly mentioned everything in ClanLib is for internal use in clan-core. + +## Stable Attributes + +The following attributes are publicly maintained + +### `clanLib.clan` + +A function that takes [clan options](../../reference/options/clan.md) +The option definitions can be composed by means of `imports` + +Returns an evaluated clan configuration - A `lib.evalModules` result: + +- `.config`: *The main result* +- `.options`,`.moduleGraph`, ...: For debugging. \ No newline at end of file