diff --git a/docs/README.md b/docs/README.md index a040f5a33..2944df80c 100755 --- a/docs/README.md +++ b/docs/README.md @@ -77,7 +77,7 @@ pip install anta[cli] ## Documentation -The documentation is published on [ANTA package website](https://anta.arista.com). Also, a [demo repository](https://github.com/titom73/atd-anta-demo) is available to facilitate your journey with ANTA. +The documentation is published on [ANTA package website](https://anta.arista.com). ## Contribution guide diff --git a/docs/advanced_usages/custom-tests.md b/docs/advanced_usages/custom-tests.md index ba62636b1..c6a2fa896 100644 --- a/docs/advanced_usages/custom-tests.md +++ b/docs/advanced_usages/custom-tests.md @@ -334,10 +334,10 @@ For that, you need to create your own Python package as described in this [hitch It is very similar to what is documented in [catalog section](../usage-inventory-catalog.md) but you have to use your own package name.2 -Let say the custom Python package is `anta_titom73` and the test is defined in `anta_titom73.dc_project` Python module, the test catalog would look like: +Let say the custom Python package is `anta_custom` and the test is defined in `anta_custom.dc_project` Python module, the test catalog would look like: ```yaml -anta_titom73.dc_project: +anta_custom.dc_project: - VerifyFeatureX: minimum: 1 ``` diff --git a/docs/cli/nrfu.md b/docs/cli/nrfu.md index 76605cbde..90b4a4045 100644 --- a/docs/cli/nrfu.md +++ b/docs/cli/nrfu.md @@ -67,7 +67,7 @@ Options: ```bash anta nrfu --device DC1-LEAF1A text ``` -[![anta nrfu text results](../imgs/anta-nrfu-text-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-text-output.png) +![anta nrfu text results](../imgs/anta-nrfu-text-output.png){ loading=lazy width="1600" } ## Performing NRFU with table rendering @@ -92,31 +92,31 @@ The `--group-by` option show a summarized view of the test results per host or p ```bash anta nrfu --tags LEAF table ``` -[![anta nrfu table results](../imgs/anta-nrfu-table-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-table-output.png) +![anta nrfu table results](../imgs/anta-nrfu-table-output.png){ loading=lazy width="1600" } For larger setups, you can also group the results by host or test to get a summarized view: ```bash anta nrfu table --group-by device ``` -[![anta nrfu table group_by_host_output](../imgs/anta-nrfu-table-group-by-host-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-table-group-by-host-output.png) +![$1anta nrfu table group_by_host_output](../imgs/anta-nrfu-table-group-by-host-output.png){ loading=lazy width="1600" } ```bash anta nrfu table --group-by test ``` -[![anta nrfu table group_by_test_output](../imgs/anta-nrfu-table-group-by-test-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-table-group-by-test-output.png) +![$1anta nrfu table group_by_test_output](../imgs/anta-nrfu-table-group-by-test-output.png){ loading=lazy width="1600" } To get more specific information, it is possible to filter on a single device or a single test: ```bash anta nrfu --device spine1 table ``` -[![anta nrfu table filter_host_output](../imgs/anta-nrfu-table-filter-host-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-table-filter-host-output.png) +![$1anta nrfu table filter_host_output](../imgs/anta-nrfu-table-filter-host-output.png){ loading=lazy width="1600" } ```bash anta nrfu --test VerifyZeroTouch table ``` -[![anta nrfu table filter_test_output](../imgs/anta-nrfu-table-filter-test-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-table-filter-test-output.png) +![$1anta nrfu table filter_test_output](../imgs/anta-nrfu-table-filter-test-output.png){ loading=lazy width="1600" } ## Performing NRFU with JSON rendering @@ -143,7 +143,7 @@ The `--output` option allows you to save the JSON report as a file. ```bash anta nrfu --tags LEAF json ``` -[![anta nrfu json results](../imgs/anta-nrfu-json-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-json-output.png) +![$1anta nrfu json results](../imgs/anta-nrfu-json-output.png){ loading=lazy width="1600" } ## Performing NRFU with custom reports @@ -173,7 +173,7 @@ The `--output` option allows you to choose the path where the final report will ```bash anta nrfu --tags LEAF tpl-report --template ./custom_template.j2 ``` -[![anta nrfu tpl_resultss](../imgs/anta-nrfu-tpl-report-output.png){ loading=lazy width="1600" }](../imgs/anta-nrfu-tpl-report-output.png) +![$1anta nrfu tpl_results](../imgs/anta-nrfu-tpl-report-output.png){ loading=lazy width="1600" } The template `./custom_template.j2` is a simple Jinja2 template: @@ -205,4 +205,4 @@ cat nrfu-tpl-report.txt It is possible to run `anta nrfu --dry-run` to execute ANTA up to the point where it should communicate with the network to execute the tests. When using `--dry-run`, all inventory devices are assumed to be online. This can be useful to check how many tests would be run using the catalog and inventory. -[![anta nrfu dry_run](../imgs/anta_nrfu___dry_run.svg){ loading=lazy width="1600" }](../imgs/anta_nrfu___dry_run.svg) +![$1anta nrfu dry_run](../imgs/anta_nrfu___dry_run.svg){ loading=lazy width="1600" } diff --git a/docs/usage-inventory-catalog.md b/docs/usage-inventory-catalog.md index 71b05b032..f46993366 100644 --- a/docs/usage-inventory-catalog.md +++ b/docs/usage-inventory-catalog.md @@ -205,10 +205,10 @@ anta.tests.configuration: ### Catalog with custom tests In case you want to leverage your own tests collection, use your own Python package in the test catalog. -So for instance, if my custom tests are defined in the `titom73.tests.system` Python module, the test catalog will be: +So for instance, if my custom tests are defined in the `custom.tests.system` Python module, the test catalog will be: ```yaml -titom73.tests.system: +custom.tests.system: - VerifyPlatform: type: ['cEOS-LAB'] ``` diff --git a/mkdocs.yml b/mkdocs.yml index b4cc248c9..db08e737d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -112,6 +112,14 @@ plugins: - git-revision-date-localized: type: date - mike: + - glightbox: + background: none + shadow: true + touchNavigation: true + loop: false + effect: fade + slide_effect: slide + width: 90vw markdown_extensions: - attr_list diff --git a/pyproject.toml b/pyproject.toml index 5f0eb09c6..9517e860d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -91,6 +91,7 @@ doc = [ "mkdocs-material>=8.3.9", "mkdocs>=1.3.1", "mkdocstrings[python]>=0.20.0", + "mkdocs-glightbox>=0.4.0" ] [project.urls]