docs: Move command reference to own section (#258)

unioslo · Nov 26, 2024 · d15120e · d15120e
1 parent 8d83bad
commit d15120e
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -22,8 +22,8 @@ zabbix_cli/commands/_dev.py
 dev/
 
 # Auto-generated docs files
-docs/guide/commands/*
-!docs/guide/commands/index.md
+docs/commands/*
+!docs/commands/index.md
 docs/data
 site/
 

diff --git a/README.md b/README.md
@@ -96,7 +96,7 @@ Zabbix-cli is a command line interface for Zabbix. It can be used in three ways:
 2. **Single command**: Run a single command by running `zabbix-cli COMMAND`. This will run the command and print the output.
 3. **Batch mode**: Run multiple commands from a file by running `zabbix-cli -f FILE`. The file should contain one command per line.
 
-Command reference can be found in the [online user guide](https://unioslo.github.io/zabbix-cli/guide/commands/) or by running `zabbix-cli --help`.
+Command reference can be found in the [online user guide](https://unioslo.github.io/zabbix-cli/commands/) or by running `zabbix-cli --help`.
 
 ### Authentication
 

diff --git a/docs/guide/commands/index.md → docs/commands/index.md b/docs/guide/commands/index.md → docs/commands/index.md
diff --git a/docs/guide/authentication.md b/docs/guide/authentication.md
@@ -2,8 +2,8 @@
 
 Zabbix-cli provides several ways to authenticate. They are tried in the following order:
 
-1. [Token - Config file](#api-token-config-file)
-1. [Token - Environment variables](#api-token-environment-variables)
+1. [Token - Config file](#config-file)
+1. [Token - Environment variables](#environment-variables)
 1. [Token - Auth token file](#auth-token-file)
 1. [Password - Config file](#config-file_1)
 1. [Password - Auth file](#auth-file)

diff --git a/docs/scripts/common.py b/docs/scripts/common.py
@@ -14,6 +14,6 @@
 TEMPLATES_DIR = DOC_DIR / "templates"
 
 # Directory of generated command doc pages
-COMMANDS_DIR = DOC_DIR / "guide" / "commands"
+COMMANDS_DIR = DOC_DIR / "commands"
 if not COMMANDS_DIR.exists():
     COMMANDS_DIR.mkdir(parents=True)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -102,8 +102,8 @@ nav:
     - Logging: guide/logging.md
     - Bulk Operations: guide/bulk.md
     - Migration: guide/migration.md
-    - Commands:
-      - guide/commands/*.md
+  - Commands:
+    - commands/*.md
   - Plugins:
     - Introduction: plugins/index.md
     - plugins/guide.md