Skip to content

Commit 7c9270a

Browse files
committed
adding import names to drivers.rst
1 parent 1607584 commit 7c9270a

File tree

2 files changed

+374
-347
lines changed

2 files changed

+374
-347
lines changed

add_import_names.py

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
2+
#
3+
# SPDX-License-Identifier: MIT
4+
"""
5+
Creates updated_drivers.rst which includes import names for each module.
6+
"""
7+
8+
if __name__ == '__main__':
9+
with open('docs/drivers.rst', 'r') as drivers_rst:
10+
with open("updated_drivers.rst", "w") as updated_drivers_rst:
11+
lines = drivers_rst.readlines()
12+
13+
for line in lines:
14+
15+
if "<https://docs.circuitpython.org/" in line:
16+
docs_url = line.split("<")[1].split(">")[0]
17+
#print(docs_url)
18+
19+
short_name = line.split("https://docs.circuitpython.org/projects/")[1].split("/en/latest/")[0]
20+
insert_index = line.index("<") - 1
21+
#print(f"adafruit_{short_name} | {insert_index}")
22+
23+
modified = line[:insert_index] + f" (adafruit_{short_name})" + line[insert_index:]
24+
#print(modified)
25+
updated_drivers_rst.write(modified)
26+
else:
27+
updated_drivers_rst.write(line)

0 commit comments

Comments
 (0)