Skip to content

Commit adf68ba

Browse files
committed
Fix docs build by splitting out support matrix
1 parent 2e7ab93 commit adf68ba

File tree

17 files changed

+118
-54
lines changed

17 files changed

+118
-54
lines changed

BUILDING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ To compile (or recompile) mpy-cross:
4848

4949
make -C mpy-cross
5050

51-
# Building
51+
## Building
5252

5353
There a number of ports of CircuitPython! To build for your board, change to the appropriate ports directory and build.
5454

@@ -64,7 +64,7 @@ If you aren't sure what boards exist, have a peek in the boards subdirectory of
6464
If you have a fast computer with many cores, consider adding `-j` to your build flags, such as `-j17` on
6565
a 6-core 12-thread machine.
6666

67-
# Testing
67+
## Testing
6868

6969
If you are working on changes to the core language, you might find it useful to run the test suite.
7070
The test suite in the top level `tests` directory. It needs the unix port to run.
@@ -84,7 +84,7 @@ A successful run will say something like
8484
676 tests passed
8585
30 tests skipped: buffered_writer builtin_help builtin_range_binop class_delattr_setattr cmd_parsetree extra_coverage framebuf1 framebuf16 framebuf2 framebuf4 framebuf8 framebuf_subclass mpy_invalid namedtuple_asdict non_compliant resource_stream schedule sys_getsizeof urandom_extra ure_groups ure_span ure_sub ure_sub_unmatched vfs_basic vfs_fat_fileio1 vfs_fat_fileio2 vfs_fat_more vfs_fat_oldproto vfs_fat_ramdisk vfs_userfs
8686

87-
# Debugging
87+
## Debugging
8888

8989
The easiest way to debug CircuitPython on hardware is with a JLink device, JLinkGDBServer, and an appropriate GDB.
9090
Instructions can be found at https://learn.adafruit.com/debugging-the-samd21-with-gdb
@@ -99,7 +99,7 @@ Example:
9999
If your port/build includes `arm-none-eabi-gdb-py`, consider using it instead, as it can be used for better register
100100
debugging with https://github.com/bnahill/PyCortexMDebug
101101

102-
# Code Quality Checks
102+
## Code Quality Checks
103103

104104
We apply code quality checks using pre-commit. Install pre-commit once per system with
105105

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ For SAMD21 debugging workflow tips check out [this learn guide](https://learn.ad
3838
Scott Shawcroft ([@tannewt](https://github.com/tannewt)) is the lead developer of CircuitPython
3939
and is sponsored by [Adafruit Industries LLC](https://adafruit.com). Scott is usually available
4040
during US West Coast working hours. Dan Halbert ([@dhalbert](https://github.com/dhalbert)) and
41-
Kattni Rembor ([@kattni](https://github.com/kattni)) are also sponsored by [Adafruit Industries
42-
LLC](https://adafruit.com) and are usually available during US East Coast daytime hours including
43-
some weekends.
41+
Jeff Epler ([@jepler](https://github.com/jepler)) are also sponsored by [Adafruit Industries
42+
LLC](https://adafruit.com) and are usually available during US daytime hours including some
43+
weekends.
4444

4545
They are all reachable on [Discord](https://adafru.it/discord), GitHub issues and the [Adafruit
4646
support forum](https://forums.adafruit.com/viewforum.php?f=60).

README.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,6 @@ Specifically useful documentation when starting out:
5656
- `CircuitPython Essentials <https://learn.adafruit.com/circuitpython-essentials>`__
5757
- `Example Code <https://github.com/adafruit/Adafruit_Learning_System_Guides/tree/master/CircuitPython_Essentials>`__
5858

59-
Code Search
60-
------------
61-
GitHub doesn't currently support code search on forks. Therefore, CircuitPython doesn't have code search through GitHub because it is a fork of MicroPython. Luckily, `SourceGraph <https://sourcegraph.com/github.com/adafruit/circuitpython>`_ has free code search for public repos like CircuitPython. So, visit `sourcegraph.com/github.com/adafruit/circuitpython <https://sourcegraph.com/github.com/adafruit/circuitpython>`_ to search the CircuitPython codebase online.
62-
6359
Contributing
6460
------------
6561

conf.py

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -218,12 +218,12 @@ def autoapi_prepare_jinja_env(jinja_env):
218218
"ports/nrf/usb",
219219
"ports/raspberrypi/sdk",
220220
"ports/raspberrypi/lib",
221-
"ports/silabs",
221+
"ports/silabs/gecko_sdk",
222+
"ports/silabs/tools",
222223
"ports/stm/st_driver",
223224
"ports/stm/packages",
224225
"ports/stm/peripherals",
225226
"ports/stm/ref",
226-
"ports/unix",
227227
"py",
228228
"shared/*",
229229
"shared-bindings/util.*",
@@ -362,14 +362,21 @@ def autoapi_prepare_jinja_env(jinja_env):
362362
# Additional stuff for the LaTeX preamble.
363363
#'preamble': '',
364364
# Include 3 levels of headers in PDF ToC
365-
'preamble': '\setcounter{tocdepth}{2}',
365+
'preamble': r'''
366+
\setcounter{tocdepth}{2}
367+
\hbadness=99999
368+
\hfuzz=20pt
369+
\usepackage{pdflscape}
370+
''',
366371
}
367372

368373
# Grouping the document tree into LaTeX files. List of tuples
369374
# (source start file, target name, title,
370375
# author, documentclass [howto, manual, or own class]).
371376
latex_documents = [
372-
(master_doc, 'CircuitPython.tex', 'CircuitPython Documentation',
377+
("docs/pdf", 'CircuitPython.tex', 'CircuitPython Documentation',
378+
'CircuitPython Contributors', 'manual'),
379+
("shared-bindings/support_matrix", 'SupportMatrix.tex', 'Board Support Matrix',
373380
'CircuitPython Contributors', 'manual'),
374381
]
375382

docs/pdf.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
:orphan:
2+
3+
Adafruit CircuitPython API Reference
4+
====================================
5+
6+
Welcome to the API reference documentation for Adafruit CircuitPython.
7+
This contains low-level API reference docs which may link out to separate
8+
*"getting started"* guides. `Adafruit <https://adafruit.com>`_ has many
9+
excellent tutorials available through the
10+
`Adafruit Learning System <https://learn.adafruit.com/>`_.
11+
12+
13+
.. toctree::
14+
:maxdepth: 3
15+
16+
../README.rst
17+
libraries.rst
18+
workflows
19+
environment.rst
20+
troubleshooting.rst
21+
../CONTRIBUTING
22+
../BUILDING
23+
../WEBUSB_README
24+
supported_ports.rst
25+
26+
Design and porting reference
27+
----------------------------
28+
29+
.. toctree::
30+
:maxdepth: 1
31+
32+
design_guide
33+
porting
34+
common_hal
35+
36+
API Reference
37+
----------------------
38+
39+
.. toctree::
40+
:glob:
41+
:maxdepth: 3
42+
43+
library/index.rst
44+
../shared-bindings/*/index
45+
../shared-bindings/help
46+
47+
48+
.. toctree::
49+
:maxdepth: 1
50+
51+
reference/glossary.rst
52+
../CODE_OF_CONDUCT
53+
../docs/LICENSE
54+
55+
Indices and tables
56+
==================
57+
58+
* :ref:`genindex`
59+
* :ref:`modindex`
60+
* :ref:`search`

docs/supported_ports.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,13 @@ is limited.
1212
:maxdepth: 2
1313

1414
../ports/atmel-samd/README
15+
../ports/broadcom/README
1516
../ports/cxd56/README
1617
../ports/espressif/README
1718
../ports/litex/README
1819
../ports/mimxrt10xx/README
1920
../ports/nrf/README
2021
../ports/raspberrypi/README
22+
../ports/silabs/README
2123
../ports/stm/README
24+
../ports/unix/README

ports/broadcom/README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Broadcom
2+
==================
3+
4+
This port supports running CircuitPython bare-metal on Raspberry Pi single board
5+
computers that utilize Broadcom system-on-chips.

ports/cxd56/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# CircuitPython port to Spresense #
1+
# CXD56 (Spresense) #
22

33
This directory contains the port of CircuitPython to Spresense. It is a compact
44
development board based on Sony’s power-efficient multicore microcontroller

ports/espressif/README.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
CircuitPython on Espressif SoCs
1+
Espressif
22
=======================================
33

44
This port adds the Espressif line of SoCs to CircuitPython.
@@ -10,9 +10,11 @@ Support Status:
1010
:header: SoC, Status
1111

1212
ESP32, "beta"
13+
ESP32-H2, "alpha"
1314
ESP32-C3, "beta"
15+
ESP32-C6, "alpha"
1416
ESP32-S2, "stable"
15-
ESP32-S3, "beta"
17+
ESP32-S3, "stable"
1618

1719
How this port is organized:
1820
---------------------------------------

ports/mimxrt10xx/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# CircuitPython Port To The NXP i.MX RT10xx Series
1+
# NXP i.MX RT10xx Series
22

33
This is a port of CircuitPython to the i.MX RT10xx series of chips.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy