doc: net: Add table of contents to networking docs

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

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.

View file

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

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.

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).

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.

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

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.

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

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

View file

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

View file

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

View file

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

View file

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

View file

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

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

View file

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

View file

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