Skip to content

Commit 6d9c2c5

Browse files
nickzoicnickzoic
committed
Documentation builds (though has no real content yet)
1 parent a60700b commit 6d9c2c5

3 files changed

Lines changed: 33 additions & 1 deletion

File tree

‎shared-bindings/network/__init__.c‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@
3636

3737
#include "shared-bindings/network/__init__.h"
3838

39+
//| :mod:`network` --- Network Interface Management
40+
//| ===============================================
41+
//|
42+
//| .. module:: network
43+
//| :synopsis: Network Interface Management
44+
//| :platform: SAMD
45+
3946
#if MICROPY_PY_NETWORK
4047

4148
/// \module network - network configuration

‎shared-bindings/wiznet/__init__.c‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,23 @@
3535

3636
#include "shared-bindings/network/__init__.h"
3737

38+
//| :mod:`wiznet` --- Support for WizNet hardware
39+
//| =============================================
40+
//|
41+
//| .. module:: wiznet
42+
//| :synopsis: Support for WizNet hardware
43+
//| :platform: SAMD
44+
//|
45+
//| Doc content goes here
46+
//|
47+
//| Libraries
48+
//|
49+
//| .. toctree::
50+
//| :maxdepth: 3
51+
//|
52+
//| wiznet5k
53+
//|
54+
3855
extern const mod_network_nic_type_t mod_network_nic_type_wiznet5k;
3956

4057
STATIC const mp_rom_map_elem_t mp_module_wiznet_globals_table[] = {

‎shared-bindings/wiznet/wiznet5k.c‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,15 @@
5050
#include "internet/dns/dns.h"
5151
#include "internet/dhcp/dhcp.h"
5252

53-
/// \moduleref network
53+
//| .. currentmodule:: wiznet
54+
//|
55+
//| :class:`WIZNET5K` -- wrapper for Wiznet 5500 Ethernet interface
56+
//| ===============================================================
57+
//|
58+
//| .. class:: WIZNET5K(spi, cs, rst)
59+
//|
60+
//| Create a new WIZNET5500 interface using the specified pins
61+
//|
5462

5563
typedef struct _wiznet5k_obj_t {
5664
mp_obj_base_t base;

0 commit comments

Comments
 (0)