yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: fix absolute links need to be absolute

Browse Source
This commit is contained in:
Johannes Kirschbauer
2025-10-03 18:59:21 +02:00
parent 76d1d9b167
commit 8d9d4c9089
27 changed files with 95 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/nix/render_options/__init__.py
View File

@@ -235,7 +235,7 @@ def produce_clan_core_docs() -> None:
if module_type is not None and "submodule" not in module_type:
continue
core_outputs[indexfile] += (
f" - [{submodule_name}](/reference/clan.core/{submodule_name}.md)\n"
f" - [{submodule_name}](../../reference/clan.core/{submodule_name}.md)\n"
)
core_outputs[indexfile] += options_head
@@ -327,9 +327,9 @@ Each `clanService`:
!!! Note
`clanServices` are part of Clan's next-generation service model and are intended to replace `clanModules`.
See [Migration Guide](/guides/migrations/migrate-inventory-services.md) for help on migrating.
See [Migration Guide](../../guides/migrations/migrate-inventory-services.md) for help on migrating.
Learn how to use `clanServices` in practice in the [Using clanServices guide](/guides/inventory/clanServices.md).
Learn how to use `clanServices` in practice in the [Using clanServices guide](../../guides/inventory/clanServices.md).
"""
with indexfile.open("w") as of:
@@ -424,7 +424,7 @@ Typically needed by module authors to define roles, behavior and metadata for di
!!! Note
This is not a user-facing documentation, but rather meant as a reference for *module authors*
See: [clanService Authoring Guide](/guides/services/community.md)
See: [clanService Authoring Guide](../../guides/services/community.md)
"""
# Inventory options are already included under the clan attribute
# We just omitted them in the clan docs, because we want a separate output for the inventory model
@@ -457,7 +457,7 @@ def produce_inventory_docs() -> None:
output = """# Inventory Submodule
This provides an overview of the available options of the `inventory` model.
It can be set via the `inventory` attribute of the [`clan`](/reference/options/clan_inventory.md) function, or via the [`clan.inventory`](/reference/options/clan_inventory.md) attribute of flake-parts.
It can be set via the `inventory` attribute of the [`clan`](../../reference/options/clan_inventory.md) function, or via the [`clan.inventory`](../../reference/options/clan_inventory.md) attribute of flake-parts.
"""
# Inventory options are already included under the clan attribute
@@ -499,8 +499,8 @@ def produce_clan_options_docs() -> None:
output = """# Clan Options
This provides an overview of the available options
Those can be set via [`clan-core.lib.clan`](/reference/options/clan.md) function,
or via the [`clan`](/reference/options/clan.md) attribute of flake-parts.
Those can be set via [`clan-core.lib.clan`](../../reference/options/clan.md) function,
or via the [`clan`](../../reference/options/clan.md) attribute of flake-parts.
"""
# Inventory options are already included under the clan attribute
@@ -518,7 +518,7 @@ or via the [`clan`](/reference/options/clan.md) attribute of flake-parts.
Attribute: `inventory`
See: [Inventory Submodule](/reference/options/clan_inventory.md)
See: [Inventory Submodule](../../reference/options/clan_inventory.md)
"""
continue
output += options_docs_from_tree(option, init_level=2)