Skip to content

Commit

Permalink
ci: Remove griffe version lock and fix other mkdocs stuff (#574)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmuloc authored Mar 5, 2024
1 parent b6722a9 commit 144e1e8
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 11 deletions.
2 changes: 0 additions & 2 deletions anta/result_manager/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,6 @@ def get_result_by_test(self, test_name: str) -> list[TestResult]:
Args:
test_name (str): Test name to use to filter results
output_format (str, optional): format selector. Can be either native/list. Defaults to 'native'.
Returns:
list[TestResult]: List of results related to the test.
Expand All @@ -177,7 +176,6 @@ def get_result_by_host(self, host_ip: str) -> list[TestResult]:
Args:
host_ip (str): IP Address of the host to use to filter results.
output_format (str, optional): format selector. Can be either native/list. Defaults to 'native'.
Returns:
list[TestResult]: List of results related to the host.
Expand Down
4 changes: 2 additions & 2 deletions docs/usage-inventory-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Both inputs can be defined in a file or programmatically.

## Device Inventory

A device inventory is an instance of the [AntaInventory](../api/inventory.md#anta.inventory.AntaInventory) class.
A device inventory is an instance of the [AntaInventory](./api/inventory.md#anta.inventory.AntaInventory) class.

### Device Inventory File

Expand Down Expand Up @@ -72,7 +72,7 @@ anta_inventory:

## Test Catalog

A test catalog is an instance of the [AntaCatalog](../api/catalog.md#anta.catalog.AntaCatalog) class.
A test catalog is an instance of the [AntaCatalog](./api/catalog.md#anta.catalog.AntaCatalog) class.

### Test Catalog File

Expand Down
9 changes: 3 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ plugins:
default_handler: python
handlers:
python:
paths: [anta]
import:
- https://docs.python.org/3/objects.inv
- https://mkdocstrings.github.io/objects.inv
Expand Down Expand Up @@ -115,8 +114,8 @@ plugins:
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- smarty
- pymdownx.arithmatex
- pymdownx.betterem:
Expand Down Expand Up @@ -207,8 +206,6 @@ nav:
- Result Manager:
- Result Manager module: api/result_manager.md
- Result Manager models: api/result_manager_models.md
- Report Manager:
- Report Manager module: api/report_manager.md
- Report Manager models: api/report_manager_models.md
- Report Manager: api/report_manager.md
- Contributions: contribution.md
- FAQ: faq.md
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ doc = [
"mkdocstrings[python]>=0.20.0",
"fontawesome_markdown",
"mike==2.0.0",
"griffe==0.41.1"
"griffe"
]

[project.urls]
Expand Down

0 comments on commit 144e1e8

Please sign in to comment.