Skip to content

Commit 0bcfabb

Browse files
jamesbowmanjamesbowman
committed
Add header for module eveL explaining what it is.
Exclude modeveL-gen.h from Sphinx build
1 parent 7fd30e7 commit 0bcfabb

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

‎conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@
156156
"ports/zephyr",
157157
"py",
158158
"shared-bindings/util.*",
159+
"shared-bindings/eveL/modeveL-gen.h",
159160
"shared-module",
160161
"supervisor",
161162
"tests",

‎shared-bindings/eveL/__init__.c‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,18 @@
3333

3434
// #if MICROPY_PY_BUILTINS_EVEL
3535

36+
//| :mod:`eveL` --- low-level BridgeTek EVE bindings
37+
//| ================================================
38+
//|
39+
//| .. module:: eveL
40+
//| :synopsis: low-level BridgeTek EVE bindings
41+
//| :platform: SAMD21/SAMD51
42+
//|
43+
//| The `eveL` module provides a class EVEL which
44+
//| contains methods for constructing EVE command
45+
//| buffers and appending basic graphics commands.
46+
//|
47+
3648
typedef struct _mp_obj_EVEL_t {
3749
mp_obj_base_t base;
3850
mp_obj_t writer;

0 commit comments

Comments
 (0)