From a154e811db220233c74406a5d3f252db55e18123 Mon Sep 17 00:00:00 2001 From: Alexandre Aubin Date: Thu, 9 Feb 2023 19:00:17 +0100 Subject: [PATCH] doc: improve app resource doc --- doc/generate_helper_doc.py | 2 +- doc/generate_resource_doc.py | 25 ++++++++++++++++++++++++- 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/doc/generate_helper_doc.py b/doc/generate_helper_doc.py index 63fa109e6..110d1d4cd 100644 --- a/doc/generate_helper_doc.py +++ b/doc/generate_helper_doc.py @@ -24,7 +24,7 @@ def render(helpers): data = { "helpers": helpers, - "date": datetime.datetime.now().strftime("%m/%d/%Y"), + "date": datetime.datetime.now().strftime("%d/%m/%Y"), "version": open("../debian/changelog").readlines()[0].split()[1].strip("()"), } diff --git a/doc/generate_resource_doc.py b/doc/generate_resource_doc.py index 20a9a994d..ef98dc810 100644 --- a/doc/generate_resource_doc.py +++ b/doc/generate_resource_doc.py @@ -1,6 +1,25 @@ import ast +import datetime +import subprocess -print("""--- +version = open("../debian/changelog").readlines()[0].split()[1].strip("()"), +today = datetime.datetime.now().strftime("%d/%m/%Y") + +def get_current_commit(): + p = subprocess.Popen( + "git rev-parse --verify HEAD", + shell=True, + stdout=subprocess.PIPE, + stderr=subprocess.STDOUT, + ) + stdout, stderr = p.communicate() + + current_commit = stdout.strip().decode("utf-8") + return current_commit +current_commit = get_current_commit() + + +print(f"""--- title: App resources template: docs taxonomy: @@ -9,6 +28,8 @@ routes: default: '/packaging_apps_resources' --- +Doc auto-generated by [this script](https://github.com/YunoHost/yunohost/blob/{current_commit}/doc/generate_resource_doc.py) on {today} (YunoHost version {version}) + """) @@ -35,7 +56,9 @@ for c in ResourceClasses: for resource_id, doc in sorted(ResourceDocString.items()): doc = doc.replace("\n ", "\n") + print("----------------") print("") print(f"## {resource_id.replace('_', ' ').title()}") print("") print(doc) + print("")