Skip to content

Commit 3d8fd81

Browse files
committed
Updated template
Updated the template to use a 3 column layout on each card and link to the source on github.
1 parent 5ce05b2 commit 3d8fd81

3 files changed

Lines changed: 43 additions & 17 deletions

File tree

docs/make_docs.py

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
from os import walk
55
from os.path import abspath, dirname, isfile, join
66

7-
def format_date(value, format):
8-
if format == "short":
7+
def format_date(value, fmt):
8+
if fmt == "short":
99
return value.strftime("%Y-%m-%d")
10-
elif format == "long":
10+
elif fmt == "long":
1111
return value.strftime("%B %d, %Y")
1212
else:
13-
return value.strftime(format)
13+
return value.strftime(fmt)
1414

1515
def retrieve_cards(directory):
1616
cards = []
@@ -20,17 +20,21 @@ def retrieve_cards(directory):
2020
with open(join(path, filename), 'r') as yml:
2121
readme = yaml.safe_load(yml)
2222

23-
program = join(path,readme.get('program',None))
24-
if isfile(program):
25-
with open(program, 'r') as bas:
23+
program_file = readme.get('program',None)
24+
program_full = join(path,program_file)
25+
if isfile(program_full):
26+
with open(program_full, 'r') as bas:
2627
readme['code'] = bas.read()
28+
29+
relpath = path[len(root_dir):]
30+
readme['url'] = root_url+relpath+'/'+program_file
2731

2832
screenshot = join(path,readme.get('screenshot',None))
2933
if isfile(screenshot):
3034
with open(screenshot, 'rb') as bmp:
3135
image = bmp.read()
3236

33-
outfile = readme.get('program')+'.bmp'
37+
outfile = program_file+'.bmp'
3438
with open(join(output_dir,'images',outfile), 'wb') as outbmp:
3539
outbmp.write(image)
3640
readme['screenshot'] = outfile
@@ -47,6 +51,7 @@ def retrieve_cards(directory):
4751

4852
# walk the directory looking for 'read.me' files and associated '*.bas' files
4953
root_dir = dirname(script_dir)
54+
root_url='https://github.com/aefarrell/picomite_library/blob/main'
5055
categories = [ 'math', 'art', 'utils', 'toys' ]
5156
cards = { cat:retrieve_cards(join(root_dir,cat)) for cat in categories }
5257

docs/templates/index.html

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ <h1> {{ category }} </h1>
2626

2727
<div class="col-md-9">
2828
<div class="container">
29+
2930
{% for card in cards[category] %}
3031
<div class="card border-success mb-3">
3132
<div class="card-header row m-0">
@@ -34,18 +35,27 @@ <h1> {{ category }} </h1>
3435
</div>
3536
<div class="card-body">
3637
<div class="card-text">
37-
{% if card.screenshot %}<img src="images/{{ card.screenshot }}" class="d-block user-select-none" />{% endif %}
38+
<div class="row m-0">
39+
{% if card.screenshot %}
40+
<div class="col-md-5"><img src="images/{{ card.screenshot }}" class="d-block user-select-none" /></div>
41+
<div class="col-md-5 p-0">
42+
{% else %}<div class="col-md-10 p-0">{% endif %}
3843
<p>{{ card.description }}</p>
39-
<a href="{{ card.program }}.html"><button type="button" class="btn btn-success">Source Code</button></a>
40-
</div>
44+
</div>
45+
<div class="col-md-2 p-0">
46+
<p class="text-end"><a href="{{ card.program }}.html"><button type="button" class="btn btn-success">Source</button></a></p>
47+
<p class="text-end"><a href="{{ card.url }}"><button type="button" class="btn btn-secondary">Github</button></a></p>
48+
</div>
49+
</div>
50+
</div>
4151
</div>
42-
</div>
43-
{% endfor %}
44-
</div>
4552
</div>
46-
53+
{% endfor %}
54+
55+
</div>
4756
</div>
48-
{% endif %}{% endfor %}
57+
</div>
58+
{% endif %}{% endfor %}
4959

5060
<footer class="pt-3 mt-4 text-body-secondary border-top">
5161
<p>Made with <a href="https://getbootstrap.com/">Bootstrap</a> and <a href="https://bootswatch.com/vapor/">Bootswatch Vapor</a>, by <a href="https://github.com/aefarrell">Allan Farrell</a>.</p>

docs/templates/program.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,21 @@
2525
</div>
2626
<div class="card-body">
2727
<div class="card-text">
28-
{% if program.screenshot %}<img src="images/{{ program.screenshot }}" class="d-block user-select-none" />{% endif %}
28+
<div class="row m-0">
29+
{% if program.screenshot %}<div class="col-md-5"><img src="images/{{ program.screenshot }}" class="d-block user-select-none" /></div><div class="col-md-5 p-0">
30+
{% else %}<div class="col-md-10 p-0">{% endif %}
2931
<p>{{ program.description }}</p>
32+
</div>
33+
<div class="col-md-2 p-0">
34+
<p class="text-end"><a href="{{ program.url }}"><button type="button" class="btn btn-secondary">Github</button></a></p>
35+
</div>
36+
</div>
37+
<div class="row m-0">
38+
<div class="col-md-12 p-0">
3039
<p><hr /></p>
3140
<pre class="text-success">{{ program.code }}</pre>
41+
</div>
42+
</div>
3243
</div>
3344
</div>
3445
</div>

0 commit comments

Comments
 (0)