docs: render all examples into one markdown page

This commit is contained in:
Thomas Kriechbaumer 2020-04-10 14:08:25 +02:00
parent 0d9e517c06
commit 12b37c39e1
5 changed files with 56 additions and 5 deletions

7
docs/.gitignore vendored
View File

@ -1,5 +1,6 @@
generated/
src/public
node_modules
public
src/public/
node_modules/
public/
src/resources/_gen/
src/content/addons-examples.md

View File

@ -8,5 +8,7 @@ for script in scripts/* ; do
"$script" > "src/generated/${output%.*}.html"
done
python3 render_examples > src/content/addons-examples.md
cd src
hugo

48
docs/render_examples.py Executable file
View File

@ -0,0 +1,48 @@
#!/usr/bin/env python3
import os
import textwrap
from pathlib import Path
print("""
---
title: "Examples"
menu:
addons:
weight: 6
---
# Examples of Addons and Scripts
""")
base = os.path.dirname(os.path.realpath(__file__))
examples_path = os.path.join(base, '../src/examples/')
pathlist = Path(examples_path).glob('**/*.py')
examples = [os.path.relpath(str(p), examples_path) for p in sorted(pathlist)]
examples = [p for p in examples if not os.path.basename(p) == '__init__.py']
examples = [p for p in examples if not os.path.basename(p).startswith('test_')]
current_dir = None
current_level = 2
for ex in examples:
if os.path.dirname(ex) != current_dir:
current_dir = os.path.dirname(ex)
sanitized = current_dir.replace('/', '').replace('.', '')
print(" * [Examples: {}]({{{{< relref \"addons-examples#{}\">}}}})".format(current_dir, sanitized))
sanitized = ex.replace('/', '').replace('.', '')
print(" * [{}]({{{{< relref \"addons-examples#{}\">}}}})".format(ex, sanitized))
current_dir = None
current_level = 2
for ex in examples:
if os.path.dirname(ex) != current_dir:
current_dir = os.path.dirname(ex)
print("#"*current_level, current_dir)
print(textwrap.dedent("""
{} {}
{{{{< example src="{}" lang="py" >}}}}
""".format("#"*(current_level+1), ex, "/examples/"+ex)))

View File

@ -47,6 +47,7 @@ body > div {
width: 100%;
text-align: right;
}
max-width: 70vw;
margin-bottom: 1em;
}

View File

@ -1,5 +1,4 @@
<div class="example">
{{ highlight (trim (readFile (.Get "src")) "\n\r") (.Get "lang") "" }}
<div class="path">{{ (.Get "src" )}}</div>
</div>
</div>