YunoHost/yunohost
1
0
Fork 0
mirror of https://github.com/YunoHost/yunohost.git synced 2024-09-03 20:06:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

Typo + fixes for helper doc generation

Browse source
This commit is contained in:
Alexandre Aubin 2018-11-26 14:56:47 +00:00
parent 5126b3e450
commit a455cae3bf
2 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
data/helpers.d/print
View file

@ -7,7 +7,7 @@ ynh_die() {
# Display a message in the 'INFO' logging category # Display a message in the 'INFO' logging category
# #
# usage: ynh_info "Some message" # usage: ynh_print_info "Some message"
ynh_print_info() { ynh_print_info() {
echo "$1" >> "$YNH_STDINFO" echo "$1" >> "$YNH_STDINFO"
} }

10
doc/generate_helper_doc.py
View file

@ -11,7 +11,7 @@ def render(data):
from ansi2html.style import get_styles from ansi2html.style import get_styles
conv = Ansi2HTMLConverter() conv = Ansi2HTMLConverter()
shell_css = "\n".join(map(str, get_styles(conv.dark_bg, conv.scheme))) shell_css = "\n".join(map(str, get_styles(conv.dark_bg)))
def shell_to_html(shell): def shell_to_html(shell):
return conv.convert(shell, False) return conv.convert(shell, False)
@ -28,6 +28,7 @@ class Parser():
def __init__(self, filename): def __init__(self, filename):
self.filename = filename
self.file = open(filename, "r").readlines() self.file = open(filename, "r").readlines()
self.blocks = None self.blocks = None
@ -43,6 +44,9 @@ class Parser():
for i, line in enumerate(self.file): for i, line in enumerate(self.file):
if line.startswith("#!/bin/bash"):
continue
line = line.rstrip().replace("\t", " ") line = line.rstrip().replace("\t", " ")
if current_reading == "void": if current_reading == "void":
@ -64,7 +68,7 @@ class Parser():
else: else:
# We're getting out of a comment bloc, we should find # We're getting out of a comment bloc, we should find
# the name of the function # the name of the function
assert len(line.split()) >= 1 assert len(line.split()) >= 1, "Malformed line %s in %s" % (i, self.filename)
current_block["line"] = i current_block["line"] = i
current_block["name"] = line.split()[0].strip("(){") current_block["name"] = line.split()[0].strip("(){")
# Then we expect to read the function # Then we expect to read the function
@ -143,11 +147,11 @@ class Parser():
b["usage"] = b["usage"].strip() b["usage"] = b["usage"].strip()
def is_global_comment(line): def is_global_comment(line):
return line.startswith('#') return line.startswith('#')
def malformed_error(line_number): def malformed_error(line_number):
import pdb; pdb.set_trace()
return "Malformed file line {} ?".format(line_number) return "Malformed file line {} ?".format(line_number)
def main(): def main():