aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArthur Zamarin <arthurzam@gentoo.org>2022-12-15 20:57:59 +0200
committerArthur Zamarin <arthurzam@gentoo.org>2022-12-15 20:57:59 +0200
commit77c7489ac7d781eb5416a980a49fa154e2d6b391 (patch)
tree2140005c9f0924d9cb92f4a4dc16d048e054c764 /doc
parentMissingRemoteIdCheck: give ready <remote-id/> sample (diff)
downloadpkgcheck-77c7489ac7d781eb5416a980a49fa154e2d6b391.tar.gz
pkgcheck-77c7489ac7d781eb5416a980a49fa154e2d6b391.tar.bz2
pkgcheck-77c7489ac7d781eb5416a980a49fa154e2d6b391.zip
fix docs generation style
Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>
Diffstat (limited to 'doc')
-rwxr-xr-xdoc/generate/pkgcheck/checks.py8
-rwxr-xr-xdoc/generate/pkgcheck/keywords.py8
-rwxr-xr-xdoc/generate/pkgcheck/reporters.py6
3 files changed, 14 insertions, 8 deletions
diff --git a/doc/generate/pkgcheck/checks.py b/doc/generate/pkgcheck/checks.py
index e8401079..171186fe 100755
--- a/doc/generate/pkgcheck/checks.py
+++ b/doc/generate/pkgcheck/checks.py
@@ -28,9 +28,11 @@ def main(f=sys.stdout, **kwargs):
def out(s, **kwargs):
print(s, file=f, **kwargs)
- def _rst_header(char, text, newline=True):
+ def _rst_header(char, text, newline=True, leading=False):
if newline:
out('\n', end='')
+ if leading:
+ out(char * len(text))
out(text)
out(char * len(text))
@@ -41,7 +43,7 @@ def main(f=sys.stdout, **kwargs):
wrapper = TextWrapper(width=85)
for scope in base.scopes.values():
- _rst_header('-', scope.desc.capitalize() + ' scope')
+ _rst_header('-', scope.desc.capitalize() + ' scope', leading=True)
checks = (x for x in objects.CHECKS.values() if x.scope == scope)
for check in checks:
@@ -54,7 +56,7 @@ def main(f=sys.stdout, **kwargs):
else:
summary = None
- _rst_header('^', check.__name__)
+ _rst_header('-', check.__name__)
if summary:
out('\n' + dedent(summary).strip())
if explanation:
diff --git a/doc/generate/pkgcheck/keywords.py b/doc/generate/pkgcheck/keywords.py
index 706c58a5..628d4c8f 100755
--- a/doc/generate/pkgcheck/keywords.py
+++ b/doc/generate/pkgcheck/keywords.py
@@ -23,9 +23,11 @@ def main(f=sys.stdout, **kwargs):
def out(s, **kwargs):
print(s, file=f, **kwargs)
- def _rst_header(char, text, newline=True):
+ def _rst_header(char, text, newline=True, leading=False):
if newline:
out('\n', end='')
+ if leading:
+ out(char * len(text))
out(text)
out(char * len(text))
@@ -39,7 +41,7 @@ def main(f=sys.stdout, **kwargs):
related_checks[keyword].add(check)
for scope in base.scopes.values():
- _rst_header('-', scope.desc.capitalize() + ' scope')
+ _rst_header('-', scope.desc.capitalize() + ' scope', leading=True)
keywords = (x for x in objects.KEYWORDS.values() if x.scope == scope)
for keyword in keywords:
@@ -52,7 +54,7 @@ def main(f=sys.stdout, **kwargs):
else:
summary = None
- _rst_header('^', keyword.__name__)
+ _rst_header('-', keyword.__name__)
if summary:
out('\n' + dedent(summary).strip())
if explanation:
diff --git a/doc/generate/pkgcheck/reporters.py b/doc/generate/pkgcheck/reporters.py
index aaca914c..e0debc35 100755
--- a/doc/generate/pkgcheck/reporters.py
+++ b/doc/generate/pkgcheck/reporters.py
@@ -12,9 +12,11 @@ def main(f=sys.stdout, **kwargs):
def out(s, **kwargs):
print(s, file=f, **kwargs)
- def _rst_header(char, text, newline=True):
+ def _rst_header(char, text, newline=True, leading=False):
if newline:
out('\n', end='')
+ if leading:
+ out(char * len(text))
out(text)
out(char * len(text))
@@ -34,7 +36,7 @@ def main(f=sys.stdout, **kwargs):
else:
summary = None
- _rst_header('-', reporter.__name__)
+ _rst_header('-', reporter.__name__, leading=True)
if summary:
out('\n' + dedent(summary).strip())
if explanation: