summaryrefslogtreecommitdiff
path: root/docs/templates
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2018-02-27 22:03:52 -0500
committerGitHub <noreply@github.com>2018-02-27 22:03:52 -0500
commit568c04e6afa8016062f685b2198c0209f62827f4 (patch)
treed07b76119f715add462983b335797adf64b61249 /docs/templates
parent6a2379fd0bfe10017d8abc5c36ef1d470c0d9b27 (diff)
parentea633117d01d94e8d56ed94344e4b3e46b4eef03 (diff)
Merge pull request #650 from tannewt/merge_2x3.0.0-alpha.2
Merge in commits from 2.x branch.
Diffstat (limited to 'docs/templates')
-rw-r--r--docs/templates/layout.html6
-rw-r--r--docs/templates/replace.inc6
-rw-r--r--docs/templates/topindex.html112
-rw-r--r--docs/templates/unsupported_in_circuitpython.inc5
-rw-r--r--docs/templates/versions.html37
5 files changed, 8 insertions, 158 deletions
diff --git a/docs/templates/layout.html b/docs/templates/layout.html
deleted file mode 100644
index a6caa0bc5..000000000
--- a/docs/templates/layout.html
+++ /dev/null
@@ -1,6 +0,0 @@
-{% extends "!layout.html" %}
-{% set css_files = css_files + ["_static/customstyle.css"] %}
-
-{# we change the master_doc variable so that links to the index
- page are to index.html instead of <port>_index.html #}
-{% set master_doc = "index" %}
diff --git a/docs/templates/replace.inc b/docs/templates/replace.inc
index 319c53735..2636045f6 100644
--- a/docs/templates/replace.inc
+++ b/docs/templates/replace.inc
@@ -4,6 +4,6 @@
.. |see_cpython_module| replace::
- *This module implements a subset of the corresponding* `CPython` *module,
- as described below. For more information, refer to the original
- CPython documentation:*
+ *This module implements a subset of the corresponding* ``CPython`` *module,
+ as described below. For more information, refer to the original*
+ ``CPython`` *documentation:*
diff --git a/docs/templates/topindex.html b/docs/templates/topindex.html
deleted file mode 100644
index 76e5e18d7..000000000
--- a/docs/templates/topindex.html
+++ /dev/null
@@ -1,112 +0,0 @@
-{% extends "defindex.html" %}
-{% block body %}
-
- <h1>MicroPython documentation</h1>
-
- <p>
- {{ _('Welcome! This is the documentation for MicroPython') }}
- v{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
- </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 MicroPython and {{ port_name }}:</strong></p>
-
- <table class="contentstable"><tr>
- <td width="40%" style="padding-left:2em;">
- {% if port in ("pyboard", "wipy", "esp8266") %}
- <p class="biglink">
- <a class="biglink" href="{{ pathto(port + "/quickref") }}">Quick reference for {{ port_name }}</a><br/>
- <span class="linkdescr">pinout for {{ port_name }} and snippets of useful code</span>
- </p>
- <p class="biglink">
- <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>
- </p>
- <p class="biglink">
- <a class="biglink" href="{{ pathto(port + "/tutorial/index") }}">Tutorials and code examples</a><br/>
- <span class="linkdescr">start here</span>
- </p>
- {% endif %}
- <p class="biglink">
- <a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br/>
- {% if port == "pyboard" %}
- <span class="linkdescr">MicroPython libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span>
- {% else %}
- <span class="linkdescr">MicroPython libraries, including the <a href="{{ pathto("library/machine") }}">machine module</a></span>
- {% endif %}
- </p>
- <p class="biglink">
- <a class="biglink" href="{{ pathto("genrst/index") }}">MicroPython Differences</a><br/>
- <span class="linkdescr">MicroPython operations which differ from CPython</span>
- </p>
- </td>
- <td width="40%" style="padding-left:2em;">
- <p class="biglink">
- <a class="biglink" href="{{ pathto("reference/index") }}">Language Reference</a><br/>
- <span class="linkdescr">information about MicroPython specific language features</span>
- </p>
- <p class="biglink">
- <a class="biglink" href="{{ pathto("license") }}">License</a><br/>
- <span class="linkdescr">MicroPython license information</span>
- </p>
- </td>
- </tr></table>
-
- <p><strong>Indices and tables:</strong></p>
- <table class="contentstable"><tr>
- <td width="40%" style="padding-left:2em;">
- <p class="biglink">
- <a class="biglink" href="{{ pathto("py-modindex") }}">Module index</a><br/>
- <span class="linkdescr">quick access to all modules</span>
- </p>
- <p class="biglink">
- <a class="biglink" href="{{ pathto("genindex") }}">Full index</a><br/>
- <span class="linkdescr">all functions, classes, constants</span>
- </p>
- </td>
- <td width="40%" style="padding-left:2em;">
- <p class="biglink">
- <a class="biglink" href="{{ pathto("reference/glossary") }}">Glossary</a><br/>
- <span class="linkdescr">MicroPython terms explained</span>
- </p>
- <p class="biglink">
- <a class="biglink" href="{{ pathto(port + "_index") }}">Table of contents</a><br/>
- <span class="linkdescr">a list of all sections and subsections</span>
- </p>
- </td></tr>
- </table>
-
- <p><strong>External links:</strong></p>
-
- <table class="contentstable"><tr>
- <td width="40%" style="padding-left:2em;">
- <p class="biglink">
- <a class="biglink" href="http://micropython.org">MicroPython homepage</a><br/>
- <span class="linkdescr">the official MicroPython site</span>
- </p>
- <p class="biglink">
- <a class="biglink" href="http://forum.micropython.org">MicroPython forum</a><br/>
- <span class="linkdescr">community discussion for all things related to MicroPython</span>
- </p>
- </td>
- <td width="40%" style="padding-left:2em;">
- <p class="biglink">
- <a class="biglink" href="https://github.com/micropython">MicroPython on GitHub</a><br/>
- <span class="linkdescr">contribute to the source code on GitHub</span>
- </p>
- </td>
- </tr></table>
-
-{% endblock %}
diff --git a/docs/templates/unsupported_in_circuitpython.inc b/docs/templates/unsupported_in_circuitpython.inc
new file mode 100644
index 000000000..18c9215a8
--- /dev/null
+++ b/docs/templates/unsupported_in_circuitpython.inc
@@ -0,0 +1,5 @@
+.. warning::
+
+ This module is inherited from MicroPython and may not work in CircuitPython
+ as documented or at all! If they do work, they may change at any time. It is
+ unsupported.
diff --git a/docs/templates/versions.html b/docs/templates/versions.html
deleted file mode 100644
index 198630dd7..000000000
--- a/docs/templates/versions.html
+++ /dev/null
@@ -1,37 +0,0 @@
-<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
- <span class="rst-current-version" data-toggle="rst-current-version">
- <span class="fa fa-book"> Ports and Versions</span>
- {{ port }} ({{ port_version }})
- <span class="fa fa-caret-down"></span>
- </span>
- <div class="rst-other-versions">
- <dl>
- <dt>Ports</dt>
- {% for slug, url in all_ports %}
- <dd><a href="{{ url }}">{{ slug }}</a></dd>
- {% endfor %}
- </dl>
- <dl>
- <dt>Versions</dt>
- {% for slug, url in all_versions %}
- <dd><a href="{{ url }}">{{ slug }}</a></dd>
- {% endfor %}
- </dl>
- <dl>
- <dt>Downloads</dt>
- {% for type, url in downloads %}
- <dd><a href="{{ url }}">{{ type }}</a></dd>
- {% endfor %}
- </dl>
- <hr/>
- <dl>
- <dt>External links</dt>
- <dd>
- <a href="http://www.micropython.org">micropython.org</a>
- </dd>
- <dd>
- <a href="https://github.com/micropython/micropython">GitHub</a>
- </dd>
- </dl>
- </div>
-</div>