michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: net: Add table of contents to networking docs

Browse source 
This allows easy access to different part of the page.

Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>
This commit is contained in:
Jukka Rissanen 2019-02-27 15:29:53 +02:00 • committed by Anas Nashif
commit 575040496d
35 changed files with 135 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/guides/networking/native_posix_setup.rst
View file

@ -3,6 +3,10 @@
Networking with native_posix board
##################################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between a (Linux) host
and a Zephyr application running in a native_posix board.

4
doc/guides/networking/overview.rst
View file

@ -3,6 +3,10 @@
Overview
########
.. contents::
:local:
:depth: 2
Supported Features
******************

4
doc/guides/networking/qemu_eth_setup.rst
View file

@ -3,6 +3,10 @@
Networking with QEMU Ethernet
#############################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between a (Linux) host
and a Zephyr application running in QEMU.

4
doc/guides/networking/qemu_setup.rst
View file

@ -3,6 +3,10 @@
Networking with QEMU
####################
.. contents::
:local:
:depth: 2
This page describes how to set up a virtual network between a (Linux) host
and a Zephyr application running in a QEMU virtual machine (built for Zephyr
targets such as qemu_x86 and qemu_cortex_m3).

4
doc/guides/networking/usbnet_setup.rst
View file

@ -3,6 +3,10 @@
USB Device Networking
#####################
.. contents::
:local:
:depth: 2
This page describes how to set up networking between a Linux host
and a Zephyr application running on USB supported devices.

4
doc/reference/networking/coap.rst
View file

@ -3,6 +3,10 @@
CoAP
#####
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/dhcpv4.rst
View file

@ -3,6 +3,10 @@
DHCPv4
######
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/dns_resolve.rst
View file

@ -3,6 +3,10 @@
DNS Resolve
###########
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/ethernet.rst
View file

@ -3,6 +3,10 @@
Ethernet
########
.. contents::
:local:
:depth: 2
.. toctree::
:maxdepth: 1

4
doc/reference/networking/ethernet_mgmt.rst
View file

@ -3,6 +3,10 @@
Ethernet Management
###################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/gptp.rst
View file

@ -3,6 +3,10 @@
generic Precision Time Protocol (gPTP)
######################################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/ieee802154.rst
View file

@ -3,6 +3,10 @@
IEEE 802.15.4
#############
.. contents::
:local:
:depth: 2
Overview
********
IEEE 802.15.4 is a technical standard which defines the operation of low-rate

4
doc/reference/networking/ip_4_6.rst
View file

@ -3,6 +3,10 @@
IPv4/IPv6 Primitives and Helpers
################################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/lldp.rst
View file

@ -3,6 +3,10 @@
Link Layer Discovery Protocol
#############################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/lwm2m.rst
View file

@ -3,6 +3,10 @@
Lightweight M2M (LWM2M)
#######################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/mqtt.rst
View file

@ -3,6 +3,10 @@
MQTT
####
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_config.rst
View file

@ -3,6 +3,10 @@
Network Configuration Library
#############################
.. contents::
:local:
:depth: 2
Overview
********

3
doc/reference/networking/net_context.rst
View file

@ -3,8 +3,5 @@
Networking Context
##################
Overview
********
The net_context API is not meant for application use. Application should use
:ref:`bsd_sockets_interface` API instead.

4
doc/reference/networking/net_core.rst
View file

@ -3,6 +3,10 @@
Network Core Helpers
####################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_hostname.rst
View file

@ -3,6 +3,10 @@
Hostname Configuration
######################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_if.rst
View file

@ -3,6 +3,10 @@
Network Interface
#################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_l2.rst
View file

@ -3,6 +3,10 @@
L2 Layer Management
###################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_linkaddr.rst
View file

@ -3,6 +3,10 @@
Link Layer Address Handling
###########################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_mgmt.rst
View file

@ -3,6 +3,10 @@
Network Management
##################
.. contents::
:local:
:depth: 2
Overview
********

7
doc/reference/networking/net_offload.rst
View file

@ -1,5 +1,12 @@
.. _net_offload_interface:
Network Traffic Offloading
==========================
.. contents::
:local:
:depth: 2
Network Offloading
##################

4
doc/reference/networking/net_pkt.rst
View file

@ -3,6 +3,10 @@
Packet Management
#################
.. contents::
:local:
:depth: 2
Overview
********

3
doc/reference/networking/net_shell.rst
View file

@ -3,9 +3,6 @@
Network Shell
#############
Overview
********
Network shell provides helpers for figuring out network status,
enabling/disabling features, and issuing commands like ping or DNS resolving.
Note that ``net-shell`` should probably not be used in production code

4
doc/reference/networking/net_stats.rst
View file

@ -3,6 +3,10 @@
Network Statistics
##################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/net_timeout.rst
View file

@ -3,6 +3,10 @@
Network Timeout
###############
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/promiscuous.rst
View file

@ -3,6 +3,10 @@
Promiscuous Mode
################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/ptp_time.rst
View file

@ -4,6 +4,10 @@
Precision Time Protocol (PTP) time format
#########################################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/sockets.rst
View file

@ -3,6 +3,10 @@
BSD Sockets
###########
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/thread.rst
View file

@ -3,6 +3,10 @@
Thread protocol
###############
.. contents::
:local:
:depth: 2
Overview
********
Thread is a low-power mesh networking technology, designed specifically for home

4
doc/reference/networking/trickle.rst
View file

@ -3,6 +3,10 @@
Trickle Timer Library
#####################
.. contents::
:local:
:depth: 2
Overview
********

4
doc/reference/networking/vlan.rst
View file

@ -3,6 +3,10 @@
Virtual LAN (VLAN) Support
##########################
.. contents::
:local:
:depth: 2
Overview
********