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

Docs: Sync dev-platforms

Browse Source
This commit is contained in:
Ivan Kravets
2022-08-01 13:06:12 +03:00
parent fa0de1dad4
commit fcb676abc6
3 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs

Submodule docs updated: 4522803cd6...2175b369e2

2
examples

Submodule examples updated: 7fbb0ec153...f98cb5a9be

13
scripts/docspregen.py
View File

@ -39,6 +39,8 @@ RST_COPYRIGHT = """.. Copyright (c) 2014-present PlatformIO <contact@platformio
limitations under the License. limitations under the License.
""" """
SKIP_DEBUG_TOOLS = ["esp-bridge", "esp-builtin"]
DOCS_ROOT_DIR = os.path.realpath( DOCS_ROOT_DIR = os.path.realpath(
os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "docs") os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "docs")
) )
@ -904,10 +906,12 @@ You can switch between debugging :ref:`debugging_tools` using
) )
for (tool_name, tool_data) in sorted(board["debug"]["tools"].items()): for (tool_name, tool_data) in sorted(board["debug"]["tools"].items()):
lines.append( lines.append(
""" * - :ref:`debugging_tool_{name}` """ * - {tool}
- {onboard} - {onboard}
- {default}""".format( - {default}""".format(
name=tool_name, tool=f"``{tool_name}``"
if tool_name in SKIP_DEBUG_TOOLS
else f":ref:`debugging_tool_{tool_name}`",
onboard="Yes" if tool_data.get("onboard") else "", onboard="Yes" if tool_data.get("onboard") else "",
default="Yes" if tool_name == default_debug_tool else "", default="Yes" if tool_name == default_debug_tool else "",
) )
@ -984,7 +988,10 @@ Boards
for tool, platforms in tool_to_platforms.items(): for tool, platforms in tool_to_platforms.items():
tool_path = os.path.join(DOCS_ROOT_DIR, "plus", "debug-tools", "%s.rst" % tool) tool_path = os.path.join(DOCS_ROOT_DIR, "plus", "debug-tools", "%s.rst" % tool)
if not os.path.isfile(tool_path): if not os.path.isfile(tool_path):
click.secho("Unknown debug tool `%s`" % tool, fg="red") if tool in SKIP_DEBUG_TOOLS:
click.secho("Skipped debug tool `%s`" % tool, fg="yellow")
else:
click.secho("Unknown debug tool `%s`" % tool, fg="red")
continue continue
platforms = sorted(set(platforms)) platforms = sorted(set(platforms))