Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,5 @@ If pre-commit fails, fix the issues and run again. Do NOT commit until pre-commi
4. Confirm tests cover real user scenarios

```

```
6 changes: 6 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ jobs:
fi
echo "Asset link validation passed"

- name: Generate CLI documentation
run: uv run python scripts/generate_cli_docs.py

- name: Generate platform documentation
run: uv run python scripts/generate_platform_docs.py

- name: Build documentation
run: uv run mkdocs build --strict --verbose

Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ instance/
# Sphinx documentation
docs/_build/

# Auto-generated documentation
docs/.generated/

# PyBuilder
.pybuilder/
target/
Expand Down
7 changes: 7 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ repos:
require_serial: false
pass_filenames: true

- id: generate-platform-docs
name: Generate platform documentation
entry: uv run python scripts/generate_platform_docs.py
language: system
files: ^src/network_toolkit/platforms/registry\.py$
pass_filenames: false

- repo: https://github.com/Yelp/detect-secrets
rev: v1.5.0
hooks:
Expand Down
8 changes: 8 additions & 0 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -225,16 +225,24 @@ tasks:
- find . -type f -name "*.pyc" -delete 2>/dev/null || true
- echo "Clean complete!"

generate-docs:
desc: Generate platform documentation from registry
cmds:
- echo "Generating platform documentation from registry..."
- uv run python scripts/generate_platform_docs.py

docs:
desc: Build documentation (regenerates CLI docs first)
deps:
- generate-docs
- docs:build
cmds:
- echo "Documentation build complete."

docs:serve:
desc: Serve documentation locally with live reload (regenerates CLI docs first)
deps:
- generate-docs
- docs:generate
cmds:
- echo "Serving documentation on http://0.0.0.0:8000 ..."
Expand Down
14 changes: 7 additions & 7 deletions docs/.generated/platform_support_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

| Platform | Vendor | Status | Firmware | Backup | Docs |
| ----------------- | -------- | ------ | -------- | ------ | ------------------------------------- |
| Arista EOS | Arista | [S] | No | No | [Guide](../vendors/arista/index.md) |
| Cisco IOS | Cisco | [I] | Yes | Yes | [Guide](../vendors/cisco/index.md) |
| Cisco IOS-XE | Cisco | [I] | Yes | Yes | [Guide](../vendors/cisco/index.md) |
| Arista EOS | Arista | [S] | No | No | [Guide](vendors/arista/index.md) |
| Cisco IOS | Cisco | [I] | Yes | Yes | [Guide](vendors/cisco/index.md) |
| Cisco IOS-XE | Cisco | [I] | Yes | Yes | [Guide](vendors/cisco/index.md) |
| Cisco IOS-XR | Cisco | [P] | No | No | - |
| Cisco NX-OS | Cisco | [S] | No | No | [Guide](../vendors/cisco/index.md) |
| Cisco NX-OS | Cisco | [S] | No | No | [Guide](vendors/cisco/index.md) |
| Generic Device | Generic | [P] | No | No | - |
| Juniper JunOS | Juniper | [S] | No | No | [Guide](../vendors/juniper/index.md) |
| Juniper JunOS | Juniper | [S] | No | No | [Guide](vendors/juniper/index.md) |
| Generic Linux | Linux | [P] | No | No | - |
| MikroTik RouterOS | MikroTik | [I] | Yes | Yes | [Guide](../vendors/mikrotik/index.md) |
| Nokia SR Linux | Nokia | [P] | No | No | [Guide](../vendors/nokia/index.md) |
| MikroTik RouterOS | MikroTik | [I] | Yes | Yes | [Guide](vendors/mikrotik/index.md) |
| Nokia SR Linux | Nokia | [P] | No | No | [Guide](vendors/nokia/index.md) |

Status Legend:

Expand Down
14 changes: 7 additions & 7 deletions docs/.generated/vendor_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@
- Device Type: `arista_eos`
- Status: sequences_only
- Data center switches - sequences available, operations coming soon
- [Documentation](../vendors/arista/index.md)
- [Documentation](arista/index.md)

### Cisco

- **Cisco IOS** [I]
- Device Type: `cisco_ios`
- Status: implemented
- Legacy Cisco switches and routers
- [Documentation](../vendors/cisco/index.md)
- [Documentation](cisco/index.md)

- **Cisco IOS-XE** [I]
- Device Type: `cisco_iosxe`
- Status: implemented
- Modern Cisco switches and routers
- [Documentation](../vendors/cisco/index.md)
- [Documentation](cisco/index.md)

- **Cisco IOS-XR** [P]
- Device Type: `cisco_iosxr`
Expand All @@ -31,7 +31,7 @@
- Device Type: `cisco_nxos`
- Status: sequences_only
- Data center switches - sequences available, operations coming soon
- [Documentation](../vendors/cisco/index.md)
- [Documentation](cisco/index.md)

### Generic

Expand All @@ -46,7 +46,7 @@
- Device Type: `juniper_junos`
- Status: sequences_only
- Enterprise switches and routers - sequences available, operations coming soon
- [Documentation](../vendors/juniper/index.md)
- [Documentation](juniper/index.md)

### Linux

Expand All @@ -61,12 +61,12 @@
- Device Type: `mikrotik_routeros`
- Status: implemented
- Primary focus, fully featured
- [Documentation](../vendors/mikrotik/index.md)
- [Documentation](mikrotik/index.md)

### Nokia

- **Nokia SR Linux** [P]
- Device Type: `nokia_srlinux`
- Status: planned
- Modern data center network OS
- [Documentation](../vendors/nokia/index.md)
- [Documentation](nokia/index.md)
Loading
Loading