TL: allowed link to main page for documentation

Author: tlunet

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+:arrow_left: [Back to main page](./README.md)
+
 -   October 7, 2022: Version 5 comes with many changes, both visible and
     invisible ones. Some of those break the existing API, but if you are
     using tests, you should be fine. Major changes include:
@@ -224,3 +226,5 @@
             expected
         -   Reworked many of the internal structures for consistency and
             simplicity
+
+:arrow_left: [Back to main page](./README.md)

CODE_OF_CONDUCT.md

@@ -1,5 +1,7 @@
 # Contributor Covenant Code of Conduct
 
+:arrow_left: [Back to main page](./README.md)
+
 ## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our
@@ -126,3 +128,5 @@ enforcement ladder](https://github.com/mozilla/diversity).
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
 https://www.contributor-covenant.org/translations.
+
+:arrow_left: [Back to main page](./README.md)

CONTRIBUTING.md

@@ -13,4 +13,6 @@ This follows a specific OOP framework, you can look at the page on [custom imple
 2. [Pull Requests Recommendations](./docs/contrib/01_pull_requests.md)
 3. [Continuous Integration](./docs/contrib/02_continuous_integration.md)
 4. [Naming Conventions](./docs/contrib/03_naming_conventions.md)
-5. [Custom Implementations](./docs/contrib/04_custom_implementations.md)
+5. [Custom Implementations](./docs/contrib/04_custom_implementations.md)
+
+:arrow_left: [Back to main page](./README.md)

docs/convert_markdown.py

@@ -78,6 +78,9 @@ def setImgPath(rst):
             i += 16
     return rst
 
+def linkReadmeToIndex(rst):
+    return rst.replace('<./README>', '<./index>')
+
 def convert(md, orphan=False, sectionRefs=True):
     baseName = os.path.splitext(md)[0]
     rst = m2r2.parse_from_file(md, parse_relative_links=True)
@@ -88,6 +91,7 @@ def convert(md, orphan=False, sectionRefs=True):
     if orphan:
         rst = addOrphanTag(rst)
     rst = setImgPath(rst)
+    rst = linkReadmeToIndex(rst)
     with open(f'{docSources}/{baseName}.rst', 'w') as f:
         f.write(rst)
     print(f'Converted {md} to {docSources}/{baseName}.rst')