Skip to content

Commit 0b50db6

Browse files
committed
Add changelog, fix formatting and bump version
1 parent 56da982 commit 0b50db6

File tree

6 files changed

+29
-19
lines changed

6 files changed

+29
-19
lines changed

CHANGELOG.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Change Log
2+
3+
## 0.5.1
4+
5+
### Added
6+
7+
Further documentation better describing the Build HAT library components along with supported hardware.
8+
9+
### Changed
10+
11+
n/a
12+
13+
### Removed
14+
15+
n/a

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,14 @@ Documentation
3131
-------------
3232

3333
Instructions for regenerating the documentation can be found in
34-
docs/README.md. Briefly, assuming you have the appropriate python
34+
`docs/README.md`. Briefly, assuming you have the appropriate python
3535
modules installed:
3636

3737
```
3838
$ (cd docs; make html)
3939
```
4040

41-
will rebuild the documentation. The doc tree starts at
42-
``docs/build/html/index.html``
41+
will rebuild the documentation. The doc tree starts at `docs/build/html/index.html`
4342

4443

4544
Usage

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.5.0
1+
0.5.1

docs/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,4 @@
126126
html_additional_pages = {"index": "topindex.html"}
127127

128128
# Output file base name for HTML help builder.
129-
htmlhelp_basename = 'Hubdoc'
129+
htmlhelp_basename = 'BuildHATdoc'

docs/templates/topindex.html

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
{% extends "layout.html" %}
22
{% block body %}
33

4-
<h1>Build HAT Documentation</h1>
4+
<h1>{{ _('Build HAT Documentation') }}</h1>
55

6-
<p>
7-
{{ _('Welcome! This is the documentation for the Raspberry Pi Build HAT') }}
8-
{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
9-
</p>
6+
<p>{{ _('Welcome! This is the documentation for the Raspberry Pi Build HAT') }}{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.</p>
107

11-
<table class="contentstable"><tr>
8+
<table class="contentstable">
9+
<tr>
1210
<td width="40%" style="padding-left:2em;">
1311
<p class="biglink">
1412
<a class="biglink" href="{{ pathto("buildhat/index") }}">Library Reference</a><br/>
@@ -21,6 +19,7 @@ <h1>Build HAT Documentation</h1>
2119
<span class="linkdescr">License information</span>
2220
</p>
2321
</td>
24-
</tr></table>
22+
</tr>
23+
</table>
2524

2625
{% endblock %}

docs/templates/versions.html

+4-7
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,10 @@
2525
</dl>
2626
<hr/>
2727
<dl>
28-
<dt>External links</dt>
29-
<dd>
30-
<a href="http://www.micropython.org">micropython.org</a>
31-
</dd>
32-
<dd>
33-
<a href="https://github.com/micropython/micropython">GitHub</a>
34-
</dd>
28+
<dt>Links</dt>
29+
<dd>
30+
<a href="https://github.com/RaspberryPiFoundation/python-build-hat">GitHub</a>
31+
</dd>
3532
</dl>
3633
</div>
3734
</div>

0 commit comments

Comments
 (0)