platformio/platformio-core
1
0
Fork 1
mirror of https://github.com/platformio/platformio-core.git synced 2025-07-29 17:47:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for PIO Unified Debugger; add wiring connections and debug probes pictures

Browse Source
This commit is contained in:
Ivan Kravets
2018-07-07 01:35:52 +03:00
parent 7c5c5b5f70
commit ca37190da4
3 changed files with 37 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
scripts/docspregen.py
View File

@ -141,22 +141,22 @@ You can switch between debugging :ref:`debugging_tools` using
""")
if onboard_debug:
lines.append("""
On-Board tools
~~~~~~~~~~~~~~
On-Board Debug Tools
~~~~~~~~~~~~~~~~~~~~~
Boards listed below have on-board debugging tools and **ARE READY** for debugging!
You do not need to use/buy external debugger.
Boards listed below have on-board debug tool and **ARE READY** for debugging!
You do not need to use/buy external debug tool.
""")
lines.extend(
generate_boards(
onboard_debug, extend_debug=True, skip_columns=skip_columns))
if external_debug:
lines.append("""
External tools
~~~~~~~~~~~~~~
External Debug Tools
~~~~~~~~~~~~~~~~~~~~~
Boards listed below are compatible with :ref:`piodebug` but depend on external
debugging tools. See "Debug" column for compatible debugging tools.
Boards listed below are compatible with :ref:`piodebug` but **DEPEND ON**
external debug tool. See "Debug" column for compatible debug tools.
""")
lines.extend(
generate_boards(
@ -614,12 +614,20 @@ popular embedded boards and IDE.
def update_debugging():
tools_to_platforms = {}
vendors = {}
platforms = []
frameworks = []
for data in BOARDS:
if not data['debug']:
continue
for tool in data['debug']['tools']:
tool = str(tool)
if tool not in tools_to_platforms:
tools_to_platforms[tool] = []
tools_to_platforms[tool].append(data['platform'])
platforms.append(data['platform'])
frameworks.extend(data['frameworks'])
vendor = data['vendor']
@ -628,6 +636,24 @@ def update_debugging():
else:
vendors[vendor] = [data]
def _update_tool_compat_platforms(content):
begin_tpl = ".. begin_compatible_platforms_"
end_tpl = ".. end_compatible_platforms_"
for tool, platforms in tools_to_platforms.items():
begin = begin_tpl + tool
end = end_tpl + tool
begin_index = content.index(begin)
end_index = content.index(end)
chunk = ["\n\n**Compatible development platforms:**\n"]
chunk.extend([
"* :ref:`platform_%s`" % str(p)
for p in sorted(set(platforms))
])
chunk.extend(["\n"])
content = content[:begin_index + len(begin)] + "\n".join(
chunk) + content[end_index:]
return content
lines = []
# Platforms
lines.append(""".. _debugging_platforms:
@ -681,7 +707,7 @@ Boards
with open(
join(util.get_source_dir(), "..", "docs", "plus", "debugging.rst"),
"r+") as fp:
content = fp.read()
content = _update_tool_compat_platforms(fp.read())
fp.seek(0)
fp.truncate()
fp.write(content[:content.index(".. _debugging_platforms:")] +