Skip to content

Commit 4960645

Browse files
committed
remove readme.md indexes
1 parent 75e2fea commit 4960645

3 files changed

Lines changed: 3 additions & 7 deletions

File tree

documentation/.scripts/generate_indexes.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ def generate_readme(directory : str, folder_order : str = [], output_file : str
5050
file_path = os.path.relpath(os.path.join(root, file), directory).replace("\\", "/") #use linux path structure
5151
file_path = urllib.parse.quote(file_path)
5252

53+
if file == "README.md": #skip
54+
continue
55+
5356
if file.endswith(".md"):
5457
first_header = extract_first_header(os.path.join(root, file))
5558
if first_header:

documentation/README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ This README file contains an index of all files in the documentation directory.
1010
- [grafana.md](dashboards/grafana.md)
1111
- [homeassistant.md](dashboards/homeassistant.md)
1212
- [nodered.md](dashboards/nodered.md) - Setting up PythonProtocolGateway on a RasPi with NodeRed Dashboard 2.0
13-
- [README.md](dashboards/README.md) - README Index
1413

1514
**devices**
1615

1716

1817
- [EG4.md](devices/EG4.md) - EG4 to MQTT
1918
- [Growatt.md](devices/Growatt.md) - Growatt To MQTT
20-
- [README.md](devices/README.md) - README Index
2119
- [Sigineer.md](devices/Sigineer.md) - Sigineer to MQTT
2220
- [SOK.md](devices/SOK.md) - SOK to MQTT
2321
- [SolArk.md](devices/SolArk.md) - SolArk to MQTT
@@ -27,20 +25,17 @@ This README file contains an index of all files in the documentation directory.
2725

2826
- [creating_and_editing_protocols.md](usage/creating_and_editing_protocols.md) - CSV
2927
- [protocols.md](usage/protocols.md) - Custom / Editing Protocols
30-
- [README.md](usage/README.md) - README Index
3128
- [transports.md](usage/transports.md) - Protocol
3229

3330
**usage/configuration_examples**
3431

3532

3633
- [modbus_rtu_to_modbus_tcp.md](usage/configuration_examples/modbus_rtu_to_modbus_tcp.md) - ModBus RTU to ModBus TCP
3734
- [modbus_rtu_to_mqtt.md](usage/configuration_examples/modbus_rtu_to_mqtt.md) - ModBus RTU to MQTT
38-
- [README.md](usage/configuration_examples/README.md) - README Index
3935

4036
**3rdparty**
4137

4238

43-
- [README.md](3rdparty/README.md) - README Index
4439

4540
**3rdparty/protocols**
4641

@@ -62,7 +57,6 @@ This README file contains an index of all files in the documentation directory.
6257
- [PACE-BMS-RS485-communication-protocol-20180615.pdf](3rdparty/protocols/PACE-BMS-RS485-communication-protocol-20180615.pdf)
6358
- [PACE-CAN-communication-protocal(PACE-CAN-TY)-20161216-.pdf](3rdparty/protocols/PACE-CAN-communication-protocal%EF%BC%88PACE-CAN-TY%EF%BC%89-20161216-.pdf)
6459
- [PYLON LFP Battery communication protocol - RS485 V2.8 20161216.pdf](3rdparty/protocols/PYLON%20LFP%20Battery%20communication%20protocol%20-%20RS485%20V2.8%2020161216.pdf)
65-
- [README.md](3rdparty/protocols/README.md) - README Index
6660
- [RS485-protocol-pylon-low-voltage-V3.3-20180821.pdf](3rdparty/protocols/RS485-protocol-pylon-low-voltage-V3.3-20180821.pdf)
6761
- [Sigineer-Solar-Inverter-RS485-Port-Modbus-RTU-Protocol-v0.11-20200302.pdf](3rdparty/protocols/Sigineer-Solar-Inverter-RS485-Port-Modbus-RTU-Protocol-v0.11-20200302.pdf)
6862
- [Sol-Ark ModBus V1.1.pdf](3rdparty/protocols/Sol-Ark%20ModBus%20V1.1.pdf)

documentation/usage/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,4 @@ This README file contains an index of all files in the documentation directory.
99

1010
- [modbus_rtu_to_modbus_tcp.md](configuration_examples/modbus_rtu_to_modbus_tcp.md) - ModBus RTU to ModBus TCP
1111
- [modbus_rtu_to_mqtt.md](configuration_examples/modbus_rtu_to_mqtt.md) - ModBus RTU to MQTT
12-
- [README.md](configuration_examples/README.md) - README Index
1312

0 commit comments

Comments
 (0)