diff options
author | Themba Dube <embeddedthemba@gmail.com> | 2021-06-07 16:07:40 -0400 |
---|---|---|
committer | Themba Dube <embeddedthemba@gmail.com> | 2021-06-07 16:07:40 -0400 |
commit | a716ac6ed267e0a2e019fe7d2fda1bef0046cdc7 (patch) | |
tree | 5e9b0a992c0be587e455464e059596d695cb83b5 /docs/_ext/lv_example.py | |
parent | 3cf5751461d6a85974da4e5c66593736ae140a1a (diff) | |
download | lvgl-a716ac6ed267e0a2e019fe7d2fda1bef0046cdc7.tar.gz lvgl-a716ac6ed267e0a2e019fe7d2fda1bef0046cdc7.zip |
feat(docs) add view on GitHub link
Diffstat (limited to 'docs/_ext/lv_example.py')
-rw-r--r-- | docs/_ext/lv_example.py | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/_ext/lv_example.py b/docs/_ext/lv_example.py index 7c5268fb9..a451890c1 100644 --- a/docs/_ext/lv_example.py +++ b/docs/_ext/lv_example.py @@ -1,14 +1,17 @@ -from docutils.parsers.rst import Directive +import os + from docutils import nodes +from docutils.parsers.rst import Directive from docutils.parsers.rst.directives.images import Image from sphinx.directives.code import LiteralInclude -import os + class LvExample(Directive): required_arguments = 3 def run(self): example_path = self.arguments[0] example_name = os.path.split(example_path)[1] + language = self.arguments[2] node_list = [] env = self.state.document.settings.env @@ -28,9 +31,9 @@ class LvExample(Directive): except FileNotFoundError: contents = 'Error encountered while trying to open ' + example_file literal_list = nodes.literal_block(contents, contents) - literal_list['language'] = self.arguments[2] + literal_list['language'] = language toggle.append(literal_list) - header.append(nodes.paragraph(text="code")) + header.append(nodes.raw(text=f"<p>code (<a class='fa fa-github' href='https://github.com/lvgl/lvgl/blob/{env.config.repo_commit_hash}/examples/{example_path}.{language}'>view on GitHub</a>)</p>", format='html')) if env.app.tags.has('html'): node_list.append(paragraph_node) node_list.append(toggle) @@ -38,8 +41,7 @@ class LvExample(Directive): def setup(app): app.add_directive("lv_example", LvExample) - app.add_config_value("example_commit_hash", "", "env") - app.add_config_value("built_example_commit_hash", "", "env") + app.add_config_value("repo_commit_hash", "", "env") return { 'version': '0.1', |