jepler/circuitpython
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

more doc updates

Browse source
This commit is contained in:
Jeff Epler 2025-08-11 12:43:07 -05:00
parent 5e6e4d102e
commit 1f4da24498
5 changed files with 31 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -17,9 +17,9 @@ datatypes are provided: `str`(including basic Unicode support), `bytes`,
`collections.namedtuple`, classes and instances. Builtin modules include
`os`, `sys`, `time`, `re`, and `struct`, etc.
Mac specific functionality is limited:
Mac specific functionality includes:
* `os.VfsMac` for interacting with filesystems
* `qd`, a dirty wrapper around QuickDraw
* The modules documented under "[Macintosh Specific libraries](https://m68k-micropython.readthedocs.io/en/latest/library/index.html#macintosh-specific-libraries)", including `qd`, wrapper around QuickDraw.
MicroPython can execute scripts in textual source form (.py files) or from
precompiled bytecode (.mpy files), in both cases either from an on-device
@ -31,9 +31,9 @@ Getting started
Grab a release image and use it with your favorite mac emulator, including the
website [Infinite Mac](https://infinitemac.org/).
See micropython's [online documentation](https://docs.micropython.org/) for the API
reference and information about using MicroPython and information about how
it is implemented. TODO: Document modules specific to m68k-micropython.
See the project's [online documentation](https://m68k-micropython.readthedocs.io/en/latest/) for the API
reference and information about using M68k-MicroPython and information about how
it is implemented.
We use [GitHub Discussions](https://github.com/orgs/m68k-micropython/discussions)
as our forum, and Mastodon (#m68kMicroPython) for chat. These

14
docs/README.md
View file

@ -1,8 +1,8 @@
MicroPython Documentation
=========================
M68k MicroPython Documentation
==============================
The MicroPython documentation can be found at:
http://docs.micropython.org/en/latest/
The M68k MicroPython documentation can be found at:
https://m68k-micropython.readthedocs.io/en/latest/
The documentation you see there is generated from the files in the docs tree:
https://github.com/micropython/micropython/tree/master/docs
@ -13,11 +13,9 @@ Building the documentation locally
If you're making changes to the documentation, you may want to build the
documentation locally so that you can preview your changes.
Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme,
preferably in a virtualenv:
Install the requirements, preferably in a virtualenv:
pip install sphinx
pip install sphinx_rtd_theme
pip install -r requirements.txt
In `micropython/docs`, build the docs:

6
docs/conf.py
View file

@ -71,7 +71,7 @@ source_suffix = ".rst"
master_doc = "index"
# General information about the project.
project = "MicroPython"
project = "M68k-MicroPython"
copyright = "- The MicroPython Documentation is Copyright © 2014-2025, " + micropy_authors
# The version info for the project you're documenting, acts as replacement for
@ -168,7 +168,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = "static/favicon.ico"
# html_favicon = "static/favicon.ico"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@ -226,7 +226,7 @@ html_additional_pages = {"index": "topindex.html"}
# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = "MicroPythondoc"
htmlhelp_basename = "M68kMicroPythondoc"
# -- Options for LaTeX output ---------------------------------------------

4
docs/templates/layout.html vendored
View file

@ -9,7 +9,7 @@
{% if is_release %}
<div class="wy-alert wy-alert-danger">
<p>
This is the {{ release }} version of the MicroPython
This is the {{ release }} version of the M68k MicroPython
documentation. The <a href="/en/latest/{{ pagename }}.html">latest
development version</a> of this page may be more current.
</p>
@ -18,7 +18,7 @@
<div class="wy-alert wy-alert-danger">
<p>
This is the documentation for the latest development branch of
MicroPython and may refer to features that are not available in released
M68k MicroPython and may refer to features that are not available in released
versions.
</p>
<p>

76
docs/templates/topindex.html vendored
View file

@ -2,18 +2,19 @@
{% set title = _('Overview') %}
{% block body %}
<h1>MicroPython documentation</h1>
<h1>M68k-MicroPython documentation</h1>
<p>
{{ _('Welcome! This is the documentation for MicroPython') }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
{{ _('Welcome! This is the documentation for M68k-MicroPython') }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
</p>
<p>
MicroPython runs on a variety of systems and hardware platforms. Here you can read
the general documentation which applies to all systems, as well as specific information
about the various platforms -
also known as <a href="{{ pathto("reference/glossary") }}#term-micropython-port">ports</a>
- that MicroPython runs on.
This is a fork of the MicroPython project, which aims to put an implementation
of Python 3.x on m68k Macintosh computers.
</p>
<p>
You can find the official micropython website at <a href="http://www.micropython.org">micropython.org</a>.
</p>
<p><strong>General documentation for MicroPython:</strong></p>
@ -41,53 +42,6 @@
</td>
</tr></table>
<p><strong>References and tutorials for specific platforms:</strong></p>
<table class="contentstable"><tr>
<td width="40%" style="padding-left:2em;">
<p class="biglink">
<a class="biglink" href="{{ pathto("pyboard/quickref") }}">Quick reference for the pyboard</a><br/>
<span class="linkdescr">pinout for the pyboard, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("esp8266/quickref") }}">Quick reference for the ESP8266</a><br/>
<span class="linkdescr">pinout for ESP8266-based boards, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("esp32/quickref") }}">Quick reference for the ESP32</a><br/>
<span class="linkdescr">pinout for ESP32-based boards, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("rp2/quickref") }}">Quick reference for the Raspberry Pi RP2xxx</a><br/>
<span class="linkdescr">pinout for rp2xxx-based boards, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("mimxrt/quickref") }}">Quick reference for the NXP i.MXRT 10xx</a><br/>
<span class="linkdescr">general introduction, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("wipy/quickref") }}">Quick reference for the WiPy/CC3200</a><br/>
<span class="linkdescr">pinout for the WiPy/CC3200, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("unix/quickref") }}">Quick reference for UNIX and Windows</a><br/>
<span class="linkdescr">command-line reference</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("zephyr/quickref") }}">Quick reference for the Zephyr port</a><br/>
<span class="linkdescr">snippets of useful code and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("renesas-ra/quickref") }}">Quick reference for the Renesas RA</a><br/>
<span class="linkdescr">general information for Renesas RA based boards, snippets of useful code, and a tutorial</span>
</p>
<p class="biglink">
<a class="biglink" href="{{ pathto("samd/quickref") }}">Quick reference for the SAMD21/SAMD51</a><br/>
<span class="linkdescr">general information for SAMD21/SAMD51 based boards, snippets of useful code, and a tutorial</span>
</p>
</td>
</tr></table>
<p><strong>Indices and tables:</strong></p>
<table class="contentstable"><tr>
@ -118,19 +72,19 @@
<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="https://github.com/orgs/micropython/discussions">GitHub Discussions</a><br/>
<span class="linkdescr">community discussion for all things related to MicroPython</span>
<a class="biglink" href="https://github.com/orgs/m68k-micropython/discussions">GitHub Discussions</a><br/>
<span class="linkdescr">community discussion for all things related to M68k-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/>
<a class="biglink" href="https://github.com/m68k-micropython">M68k-MicroPython on GitHub</a><br/>
<span class="linkdescr">contribute to the source code on GitHub</span>
</p>
<p class="biglink">
<a class="biglink" href="http://micropython.org">MicroPython homepage</a><br/>
<span class="linkdescr">the official MicroPython site, our upstream project</span>
</p>
</td>
</tr></table>