Documentation builds (though has no real content yet)

This commit is contained in:
Nick Moore 2018-10-09 22:37:49 +11:00
parent a60700b1c5
commit 6d9c2c5254
3 changed files with 33 additions and 1 deletions

View File

@ -36,6 +36,13 @@
#include "shared-bindings/network/__init__.h" #include "shared-bindings/network/__init__.h"
//| :mod:`network` --- Network Interface Management
//| ===============================================
//|
//| .. module:: network
//| :synopsis: Network Interface Management
//| :platform: SAMD
#if MICROPY_PY_NETWORK #if MICROPY_PY_NETWORK
/// \module network - network configuration /// \module network - network configuration

View File

@ -35,6 +35,23 @@
#include "shared-bindings/network/__init__.h" #include "shared-bindings/network/__init__.h"
//| :mod:`wiznet` --- Support for WizNet hardware
//| =============================================
//|
//| .. module:: wiznet
//| :synopsis: Support for WizNet hardware
//| :platform: SAMD
//|
//| Doc content goes here
//|
//| Libraries
//|
//| .. toctree::
//| :maxdepth: 3
//|
//| wiznet5k
//|
extern const mod_network_nic_type_t mod_network_nic_type_wiznet5k; extern const mod_network_nic_type_t mod_network_nic_type_wiznet5k;
STATIC const mp_rom_map_elem_t mp_module_wiznet_globals_table[] = { STATIC const mp_rom_map_elem_t mp_module_wiznet_globals_table[] = {

View File

@ -50,7 +50,15 @@
#include "internet/dns/dns.h" #include "internet/dns/dns.h"
#include "internet/dhcp/dhcp.h" #include "internet/dhcp/dhcp.h"
/// \moduleref network //| .. currentmodule:: wiznet
//|
//| :class:`WIZNET5K` -- wrapper for Wiznet 5500 Ethernet interface
//| ===============================================================
//|
//| .. class:: WIZNET5K(spi, cs, rst)
//|
//| Create a new WIZNET5500 interface using the specified pins
//|
typedef struct _wiznet5k_obj_t { typedef struct _wiznet5k_obj_t {
mp_obj_base_t base; mp_obj_base_t base;