Skip to content

Commit 24a08ca

Browse files
authored
bump mkdocs-material to 9.7 (librenms#18632)
* bump mkdocs-material to 9.7 Enable search sharing Error on broken anchors * fix docs
1 parent fc5e69f commit 24a08ca

File tree

6 files changed

+8
-6
lines changed

6 files changed

+8
-6
lines changed

.github/workflows/doc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,9 @@ jobs:
4242
-
4343
name: Build docs
4444
run: |
45-
docker run --rm -v "$(pwd):/docs" mkdocs build --strict
45+
docker run --rm -v "$(pwd):/docs" mkdocs build --strict 2>&1 | tee output.log
4646
sudo chown -R $(id -u):$(id -g) ./out
47+
echo "Problems found:" && (grep -F 'no such' output.log && exit 1 || echo "None, Good job :)")
4748
-
4849
name: Check GitHub Pages status
4950
uses: crazy-max/ghaction-github-status@v4

doc/API/Devices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1055,11 +1055,11 @@ Route: `/api/v0/devices/:hostname/ports/:ifname/:type`
10551055
- hostname can be either the device hostname or id
10561056
- ifname can be any of the interface names for the device which can be
10571057
obtained using
1058-
[`get_port_graphs`](#get_port_graphs). Please ensure that
1058+
[`get_device_ports`](#get_device_ports). Please ensure that
10591059
the ifname is urlencoded if it needs to be (i.e Gi0/1/0 would need
10601060
to be urlencoded.
10611061
- type is the port type you want the graph for, you can request a list
1062-
of ports for a device with [`get_port_graphs`](#get_port_graphs).
1062+
of ports for a device with [`get_device_ports`](#get_device_ports).
10631063

10641064
Input:
10651065

doc/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM squidfunk/mkdocs-material:9.6
1+
FROM squidfunk/mkdocs-material:9.7
22

33
RUN \
44
pip install --no-cache-dir \

doc/Extensions/Interface-Description-Parsing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ descr Cust: Example Customer [10Mbit] (T1 Telco Y CCID129031) {EXAMP0001}
3535

3636
Unix / Linux:
3737

38-
This requires an additional script to be [setup](#setup)
38+
This requires an additional script to be [setup](#device-setup)
3939

4040
```text
4141
# eth3: Cust: Example Customer [10Mbit] (T1 Telco Y CCID129031) {EXAMP0001}

doc/Extensions/Redis-Sentinel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ REDIS_SENTINEL_USERNAME=SentinelUsernameGoesHere
5757
REDIS_PASSWORD=your_redis_password
5858
```
5959

60-
For additional information on distributed polling configuration, see [Distributed-Poller.md](Distributed-Poller.md#using-redis).
60+
For additional information on distributed polling configuration, see [Distributed-Poller.md](Distributed-Poller.md#redis).
6161

6262
## Testing Your Configuration
6363

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ theme:
3232
- content.tabs.link
3333
- content.action.edit
3434
- content.code.copy
35+
- search.share
3536
site_dir: out
3637
site_url: https://docs.librenms.org
3738
markdown_extensions:

0 commit comments

Comments
 (0)