Skip to content
Snippets Groups Projects
Commit 7ca1bd31 authored by Daniel Campora's avatar Daniel Campora Committed by Damien George
Browse files

docs: Generate a separate docs build for each port.

Using Damien's approach where conf.py and topindex.html are
shared by all ports.
parent 031278f6
No related branches found
No related tags found
No related merge requests found
File moved
File moved
File moved
File moved
File moved
File moved
File moved
File moved
File moved
File moved
...@@ -8,36 +8,53 @@ ...@@ -8,36 +8,53 @@
v{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}. v{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
</p> </p>
<p>
MicroPython runs on a variety of systems and each has their own specific
documentation. You are currently viewing the documentation for
<strong>{{ port_name }}</strong>.
</p>
<!--p>
Documentation for other systems are available:
{% for p in all_ports %}
<a href="{{ p[1] }}">{{ p[0] }}</a>{% if not loop.last %}, {% endif %}
{% endfor %}.
</p-->
<p><strong>Documentation for Micro Python and the pyboard:</strong></p> <p><strong>Documentation for Micro Python and the pyboard:</strong></p>
<table class="contentstable"><tr> <table class="contentstable"><tr>
<td width="40%" style="padding-left:2em;"> <td width="40%" style="padding-left:2em;">
{% if port == "pyboard" %}
<p class="biglink"> <p class="biglink">
<a class="biglink" href="{{ pathto("quickref") }}">Quick reference for the pyboard</a><br/> <a class="biglink" href="{{ pathto(port + "/quickref") }}">Quick reference for {{ port_name }}</a><br/>
<span class="linkdescr">pinout for the pyboard and snippets of useful code</span> <span class="linkdescr">pinout for {{ port_name }} and snippets of useful code</span>
</p> </p>
<p class="biglink"> <p class="biglink">
<a class="biglink" href="{{ pathto("general") }}">General information about the pyboard</a><br/> <a class="biglink" href="{{ pathto(port + "/general") }}">General information about {{ port_name }}</a><br/>
<span class="linkdescr">read this first for a quick overview</span> <span class="linkdescr">read this first for a quick overview</span>
</p> </p>
<p class="biglink"> <p class="biglink">
<a class="biglink" href="{{ pathto("tutorial/index") }}">Tutorials and code examples</a><br/> <a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">Tutorials and code examples</a><br/>
<span class="linkdescr">start here</span> <span class="linkdescr">start here</span>
</p> </p>
{% endif %}
<p class="biglink"> <p class="biglink">
<a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br/> <a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br/>
<span class="linkdescr">Micro Python libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span> <span class="linkdescr">Micro Python libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span>
</p> </p>
</td> </td>
<td width="40%" style="padding-left:2em;"> <td width="40%" style="padding-left:2em;">
{% if port == "pyboard" %}
<p class="biglink"> <p class="biglink">
<a class="biglink" href="{{ pathto("hardware/index") }}">The pyboard hardware</a><br/> <a class="biglink" href="{{ pathto(port + "/hardware/index") }}">The {{ port }} hardware</a><br/>
<span class="linkdescr">schematics, dimensions and component datasheets</span> <span class="linkdescr">schematics, dimensions and component datasheets</span>
</p> </p>
<p class="biglink"> <p class="biglink">
<a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for pyboard on Windows (PDF)</a><br/> <a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for {{ port_name }} on Windows (PDF)</a><br/>
<span class="linkdescr">including DFU programming</span> <span class="linkdescr">including DFU programming</span>
</p> </p>
{% endif %}
<p class="biglink"> <p class="biglink">
<a class="biglink" href="{{ pathto("license") }}">License</a><br/> <a class="biglink" href="{{ pathto("license") }}">License</a><br/>
<span class="linkdescr">Micro Python license information</span> <span class="linkdescr">Micro Python license information</span>
...@@ -62,10 +79,6 @@ ...@@ -62,10 +79,6 @@
<a class="biglink" href="{{ pathto("contents") }}">Table of contents</a><br/> <a class="biglink" href="{{ pathto("contents") }}">Table of contents</a><br/>
<span class="linkdescr">a list of all sections and subsections</span> <span class="linkdescr">a list of all sections and subsections</span>
</p> </p>
<p class="biglink">
<a class="biglink" href="{{ pathto("search") }}">Search page</a><br/>
<span class="linkdescr">search this documentation</span>
</p>
</td></tr> </td></tr>
</table> </table>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment