From bbb68e8ef90484cae9c7c47600f852da71fed0c2 Mon Sep 17 00:00:00 2001
From: Kay0u
Date: Thu, 26 Nov 2020 11:45:01 +0100
Subject: [PATCH] add branch name in the helper template
---
doc/generate_helper_doc.py | 12 ++++++++++--
doc/helper_doc_template.html | 4 ++--
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/doc/generate_helper_doc.py b/doc/generate_helper_doc.py
index a97d424eb..c07877d9d 100644
--- a/doc/generate_helper_doc.py
+++ b/doc/generate_helper_doc.py
@@ -4,9 +4,17 @@ import os
import glob
import datetime
+def get_current_git_branch():
+ with open("../.git/HEAD", "r") as f:
+ head_file = f.readlines()
+ current_branch = head_file[0].split()[1].split("refs/heads/")[1]
+
+ return current_branch
def render(helpers):
+ current_branch = get_current_git_branch()
+
data = {"helpers": helpers,
"date": datetime.datetime.now().strftime("%m/%d/%Y"),
"version": open("../debian/changelog").readlines()[0].split()[1].strip("()")
@@ -25,7 +33,7 @@ def render(helpers):
template = open("helper_doc_template.html", "r").read()
t = Template(template)
t.globals['now'] = datetime.datetime.utcnow
- result = t.render(data=data, convert=shell_to_html, shell_css=shell_css)
+ result = t.render(current_branch=current_branch, data=data, convert=shell_to_html, shell_css=shell_css)
open("helpers.html", "w").write(result)
##############################################################################
@@ -197,7 +205,7 @@ def main():
for helper_file in helper_files:
category_name = os.path.basename(helper_file)
- print "Parsing %s ..." % category_name
+ print("Parsing %s ..." % category_name)
p = Parser(helper_file)
p.parse_blocks()
for b in p.blocks:
diff --git a/doc/helper_doc_template.html b/doc/helper_doc_template.html
index f96a0190e..4d73a6de9 100644
--- a/doc/helper_doc_template.html
+++ b/doc/helper_doc_template.html
@@ -2,7 +2,7 @@
App helpers
-Doc auto-generated by this script on {{data.date}} (Yunohost version {{data.version}})
+Doc auto-generated by this script on {{data.date}} (Yunohost version {{data.version}})
{% for category, helpers in data.helpers %}
@@ -72,7 +72,7 @@
{% endif %}
- Dude, show me the code !
+ Dude, show me the code !