pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: roles for linking files now correctly links to submodule repositories

Browse Source 
Closes IDF-1584
This commit is contained in:
Marius Vikhammer
2020-04-17 14:29:39 +08:00
parent 8ee1ec1270
commit e7d92b857e
3 changed files with 63 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/contribute/documenting-code.rst
+1 -1
View File
@@ -141,7 +141,7 @@ There is couple of tips, how you can make your documentation even better and mor
Linking Examples
----------------
When linking to examples on GitHub do not use absolute / hardcoded URLs. Instead, use docutils custom roles that will generate links for you. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links do not get broken when files in master branch are moved around or deleted.
When linking to examples on GitHub do not use absolute / hardcoded URLs. Instead, use docutils custom roles that will generate links for you. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links do not get broken when files in master branch are moved around or deleted. The roles will transparently handle files that are located in submodules and will link to the submodule's repository with the correct commit ID.
The following roles are provided: