docs: fix link_roles not linking correctly for certain files

Link_roles could link incorrectly if the name of a file matched the name of a submodule
This commit is contained in:
Marius Vikhammer 2020-06-22 20:42:59 +08:00 committed by Krzysztof Budzynski
parent 479269a52b
commit 32761b9782
2 changed files with 3 additions and 2 deletions

View file

@ -44,7 +44,7 @@ Tutorials
~~~~~~~~~
- `ESP-IDF and ESP32-DevKitC: debugging, unit testing, project analysis
<https://docs.platformio.org/en/latest/tutorials/espressif32/espidf_debugging_unit_testing_inspect.html?utm_source=docs.espressif.com>`__
<https://docs.platformio.org/en/latest/tutorials/espressif32/espidf_debugging_unit_testing_analysis.html?utm_source=docs.espressif.com>`__
Project Examples
~~~~~~~~~~~~~~~~

View file

@ -57,7 +57,8 @@ def github_link(link_type, idf_rev, submods, root_path, app_config):
# Redirects to submodule repo if path is a submodule, else default to IDF repo
def redirect_submodule(path, submods, rev):
for key, value in submods.items():
if path.lstrip('/').startswith(key):
# Add path separator to end of submodule path to ensure we are matching a directory
if path.lstrip('/').startswith(os.path.join(key, '')):
return value.url.replace('.git', ''), value.rev, re.sub('^/{}/'.format(key), '', path)
return IDF_REPO, rev, path