Skip to content

Commit

Permalink
Docs: fix warning from Mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
s4n-cz committed Sep 2, 2024
1 parent 6d72d98 commit 6780c23
Show file tree
Hide file tree
Showing 9 changed files with 12 additions and 31 deletions.
14 changes: 7 additions & 7 deletions docs/concepts/settings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Settings

[`Settings`](/reference/models/settings/#sereto.models.settings.Settings) provide a way to customize SeReTo according to your needs.
[`Settings`](../reference/models/settings.md#sereto.models.settings.Settings) provide a way to customize SeReTo according to your needs.

The **location** where the configuration file is stored is determined by using [`click.get_app_dir`](https://click.palletsprojects.com/en/latest/api/#click.get_app_dir) function, to provide the most appropriate location for the specific operating system. For example, on *Linux*, the configuration file is stored in `~/.config/sereto/settings.json` and on *Windows*, it is likely stored in `C:\Users\<username>\AppData\Local\sereto\settings.json`.

Expand All @@ -22,7 +22,7 @@ The `render` field consists of the following:

### `report_recipes`

List of [`RenderRecipe`](/reference/models/settings/#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *report*.
List of [`RenderRecipe`](../reference/models/settings.md#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *report*.

Example:

Expand All @@ -48,7 +48,7 @@ Example:

### `finding_recipes`

List of [`RenderRecipe`](/reference/models/settings/#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *finding*.
List of [`RenderRecipe`](../reference/models/settings.md#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *finding*.

In addition to the standard variables defined below in the [`tools`](#tools) section, the following variables are available:

Expand Down Expand Up @@ -78,7 +78,7 @@ Example:

### `sow_recipes`

List of [`RenderRecipe`](/reference/models/settings/#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *statement-of-work*.
List of [`RenderRecipe`](../reference/models/settings.md#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *statement-of-work*.

Example:

Expand All @@ -104,7 +104,7 @@ Example:

### `target_recipes`

List of [`RenderRecipe`](/reference/models/settings/#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *target*.
List of [`RenderRecipe`](../reference/models/settings.md#sereto.models.settings.RenderRecipe)s, which define the tools used to render a *target*.

In addition to the standard variables defined below in the [`tools`](#tools) section, the following variables are available:

Expand Down Expand Up @@ -134,7 +134,7 @@ Example:

### `convert_recipes`

List of [`ConvertRecipe`](/reference/models/settings/#sereto.models.settings.ConvertRecipe)s, which define the tools used to convert between different formats.
List of [`ConvertRecipe`](../reference/models/settings.md#sereto.models.settings.ConvertRecipe)s, which define the tools used to convert between different formats.

Example:

Expand Down Expand Up @@ -162,7 +162,7 @@ Example:

### `tools`

List of [`RenderTool`](/reference/models/settings/#sereto.models.settings.RenderTool)s, which are the commands with their parameters. Tools are referenced in recipes by their name.
List of [`RenderTool`](../reference/models/settings.md#sereto.models.settings.RenderTool)s, which are the commands with their parameters. Tools are referenced in recipes by their name.

The following variables are always available and will be automatically substituted for their value before running the command:

Expand Down
1 change: 0 additions & 1 deletion docs/models.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/reference/cli/cli.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/reference/reference.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ This directory houses the pandoc filters utilized for processing the markdown fi

This directory serves as a skeleton for new report projects. When creating a new project, the contents of this directory are used to populate it.

For a detailed explanation of each file, please refer to the [report structure](/concepts/report_structure/) section in the documentation.
For a detailed explanation of each file, please refer to the [report structure](concepts/report_structure.md) section in the documentation.
2 changes: 1 addition & 1 deletion docs/usage.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

# Usage

SeReTo is a command line tool. After you have [set it up](/installation), you can use it from your terminal.
SeReTo is a command line tool. After you have [set it up](installation.md), you can use it from your terminal.

## Getting Help

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ nav:
- Reference:
# - Reference: reference/reference.md
- CLI:
- reference/cli/cli.md
- reference/cli/commands.md
- reference/cli/console.md
- reference/cli/date.md
Expand All @@ -91,6 +90,7 @@ nav:
- reference/models/report.md
- reference/models/settings.md
- reference/models/target.md
- reference/models/version.md
- Utils:
- reference/utils/utils.md
- reference/utils/cleanup.md
Expand Down
2 changes: 0 additions & 2 deletions sereto/cleanup.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ def render_target_cleanup(target: Target, report: Report, settings: Settings) ->
target: The target to be cleaned up.
report: The report containing the target.
settings: The settings for the cleanup process.
version: The version of the report.
Returns:
None
Expand All @@ -68,7 +67,6 @@ def render_finding_group_cleanup(
target: The target associated with the finding group.
report: The report to render the cleanup in.
settings: The settings for rendering the report.
version: The version of the report.
Returns:
None
Expand Down
3 changes: 2 additions & 1 deletion sereto/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,8 @@ def add_targets_config(report: Report, settings: Settings) -> None:
"""Add target to the configuration for a report.
Args:
reports_path: Directory where the report is located.
report: Report's representation.
settings: Global settings.
"""
cfg = report.config
targets: list[Target] = cfg.targets if len(cfg.updates) == 0 else cfg.updates[-1].targets
Expand Down

0 comments on commit 6780c23

Please sign in to comment.