Skip to content

Commit

Permalink
TL: allowed link to main page for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tlunet committed Jan 18, 2023
1 parent 1531a70 commit eee723c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -224,3 +226,5 @@
expected
- Reworked many of the internal structures for consistency and
simplicity

:arrow_left: [Back to main page](./README.md)
4 changes: 4 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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)
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 4 additions & 0 deletions docs/convert_markdown.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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')
Expand Down

0 comments on commit eee723c

Please sign in to comment.