From d6f72a67fc3ea9f73078931111210ba1c2045381 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Sat, 2 Feb 2019 11:06:11 -0500 Subject: [PATCH] doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif --- .known-issues/doc/bluetooth.conf | 8 +++--- .known-issues/doc/display.conf | 2 +- .known-issues/doc/duplicate.conf | 6 ++--- .known-issues/doc/kernel.conf | 24 ------------------ .known-issues/doc/misc.conf | 2 +- .known-issues/doc/networking.conf | 14 +++++----- .known-issues/doc/uart.conf | 4 +-- .../bluetooth/gap-pics.rst | 0 .../bluetooth/gatt-pics.rst | 0 .../bluetooth/index.rst | 0 .../bluetooth/l2cap-pics.rst | 0 .../bluetooth/rfcomm-pics.rst | 0 .../bluetooth/sm-pics.rst | 0 doc/{subsystems => guides}/c_library.rst | 0 doc/{tools => guides}/coccinelle.rst | 0 doc/{tools => guides}/code-relocation.rst | 0 .../device_mgmt}/dfu.rst | 0 .../mgmt.rst => guides/device_mgmt/index.rst} | 0 .../documentation/index.rst} | 8 +++--- .../dts/flash_partitions.inc | 0 .../device_tree.rst => guides/dts/index.rst} | 0 doc/guides/index.rst | 23 +++++++++++++++++ doc/{tools => guides}/kconfig/index.rst | 0 .../networking/connectivity-example-app.c | 0 .../networking/index.rst} | 0 .../networking/ip-stack-architecture.dia | Bin .../networking/ip-stack-architecture.png | Bin .../networking/ip-stack-architecture.rst | 0 .../networking/ip-stack-architecture.svg | 0 .../networking/ip-stack-data-flow.dia | Bin .../networking/ip-stack-data-flow.png | Bin .../networking/ip-stack-data-flow.svg | 0 .../networking/native_posix_setup.rst | 0 .../networking/networking-api-usage.rst | 0 .../networking/overview.rst | 0 .../networking/qemu_setup.rst | 0 .../networking/usbnet_setup.rst | 0 doc/{ => guides}/porting/arch.rst | 0 doc/{ => guides}/porting/board/hierarchy.png | Bin doc/{ => guides}/porting/board_porting.rst | 0 doc/{ => guides}/porting/cmsis_rtos_v1.rst | 0 doc/{ => guides}/porting/cmsis_rtos_v2.rst | 0 doc/{ => guides}/porting/index.rst | 0 .../porting/porting_to_zephyr.rst | 0 doc/{ => guides}/porting/shields.rst | 0 doc/{subsystems => guides}/test/index.rst | 0 doc/{subsystems => guides}/test/mocking.c | 0 .../test/sanitycheck.rst | 0 doc/{subsystems => guides}/test/ztest.rst | 0 doc/{ => guides}/tools/nordic_segger.rst | 0 doc/{ => guides}/tools/opensda.rst | 0 doc/{ => guides}/tools/stlink-v21.rst | 0 doc/{subsystems => guides}/tracing/ctf.rst | 0 doc/{subsystems => guides}/tracing/index.rst | 0 doc/{tools => guides}/west/flash-debug.rst | 0 doc/{tools => guides}/west/index.rst | 0 doc/{tools => guides}/west/planned.rst | 0 doc/{tools => guides}/west/repo-tool.rst | 0 doc/{tools => guides}/west/west-apis.rst | 0 doc/{tools => guides}/west/west-mr-model.png | Bin doc/{tools => guides}/west/west-not-found.rst | 0 doc/{tools => guides}/west/why.rst | 0 doc/{tools => guides}/west/without-west.rst | 0 doc/index.rst | 10 ++++---- doc/reference.rst | 23 ----------------- .../bluetooth/connection_mgmt.rst | 0 .../bluetooth/controller.rst | 0 doc/{api => reference}/bluetooth/crypto.rst | 0 .../bluetooth/data_buffer.rst | 0 doc/{api => reference}/bluetooth/gap.rst | 0 doc/{api => reference}/bluetooth/gatt.rst | 0 doc/{api => reference}/bluetooth/hci.txt | 0 .../bluetooth/hci_drivers.rst | 0 doc/{api => reference}/bluetooth/hci_raw.rst | 0 doc/{api => reference}/bluetooth/hfp.rst | 0 doc/{api => reference}/bluetooth/index.rst | 0 doc/{api => reference}/bluetooth/l2cap.rst | 0 doc/{api => reference}/bluetooth/mesh.rst | 0 doc/{api => reference}/bluetooth/rfcomm.rst | 0 doc/{api => reference}/bluetooth/sdp.rst | 0 doc/{api => reference}/bluetooth/uuid.rst | 0 .../display/index.rst} | 0 .../drivers/index.rst} | 0 .../file_system/index.rst} | 0 doc/reference/index.rst | 23 +++++++++++++++++ .../kernel/data_passing/fifos.rst | 0 .../kernel/data_passing/lifos.rst | 0 .../kernel/data_passing/mailboxes.rst | 0 .../kernel/data_passing/message_queues.rst | 0 .../kernel/data_passing/pipes.rst | 0 .../kernel/data_passing/stacks.rst | 0 .../kernel.rst => reference/kernel/index.rst} | 0 doc/{ => reference}/kernel/memory/heap.rst | 0 doc/{ => reference}/kernel/memory/pools.rst | 0 doc/{ => reference}/kernel/memory/slabs.rst | 0 doc/{ => reference}/kernel/other/atomic.rst | 0 doc/{ => reference}/kernel/other/cpu_idle.rst | 0 .../kernel/other/cxx_support.rst | 0 doc/{ => reference}/kernel/other/float.rst | 0 .../kernel/other/interrupts.rst | 0 doc/{ => reference}/kernel/other/polling.rst | 0 .../kernel/other/ring_buffers.rst | 0 doc/{ => reference}/kernel/other/version.rst | 0 .../kernel/synchronization/mutexes.rst | 0 .../kernel/synchronization/semaphores.rst | 0 doc/{ => reference}/kernel/threads/index.rst | 0 doc/{ => reference}/kernel/timing/clocks.rst | 0 doc/{ => reference}/kernel/timing/timers.rst | 0 .../kernel/usermode/kernelobjects.rst | 0 .../kernel/usermode/memory_domain.rst | 0 .../kernel/usermode/mpu_stack_objects.rst | 0 .../kernel/usermode/mpu_userspace.rst | 0 .../kernel/usermode/syscalls.rst | 0 .../kernel/usermode/usermode.rst | 0 .../kernel/usermode/usermode_sharedmem.rst | 0 .../logging/index.rst | 0 .../logging/system_log.rst | 0 .../misc_api.rst => reference/misc/index.rst} | 0 doc/{api => reference}/networking/coap.rst | 0 doc/{api => reference}/networking/dhcpv4.rst | 0 .../networking/dns_resolve.rst | 0 .../networking/ethernet.rst | 0 .../networking/ethernet_mgmt.rst | 0 doc/{api => reference}/networking/gptp.rst | 0 .../networking/ieee802154.rst | 0 doc/{api => reference}/networking/index.rst | 0 doc/{api => reference}/networking/ip_4_6.rst | 0 doc/{api => reference}/networking/lldp.rst | 0 doc/{api => reference}/networking/lwm2m.rst | 0 doc/{api => reference}/networking/mqtt.rst | 0 doc/{api => reference}/networking/net_buf.rst | 0 .../networking/net_config.rst | 0 .../networking/net_context.rst | 0 .../networking/net_core.rst | 0 .../networking/net_hostname.rst | 0 doc/{api => reference}/networking/net_if.rst | 0 doc/{api => reference}/networking/net_l2.rst | 0 .../networking/net_linkaddr.rst | 0 .../networking/net_mgmt.rst | 0 .../networking/net_offload.rst | 0 doc/{api => reference}/networking/net_pkt.rst | 0 .../networking/net_stats.rst | 0 .../networking/net_tech.rst | 0 .../networking/net_timeout.rst | 0 .../networking/promiscuous.rst | 0 .../networking/protocols.rst | 0 .../networking/ptp_time.rst | 0 doc/{api => reference}/networking/sockets.rst | 0 .../networking/traffic-class.rst | 0 doc/{api => reference}/networking/trickle.rst | 0 doc/{api => reference}/networking/udp.rst | 0 doc/{api => reference}/networking/vlan.rst | 0 doc/{api => reference}/peripherals/adc.rst | 0 doc/{api => reference}/peripherals/can.rst | 0 .../peripherals/counter.rst | 0 doc/{api => reference}/peripherals/dma.rst | 0 .../peripherals/entropy.rst | 0 doc/{api => reference}/peripherals/flash.rst | 0 doc/{api => reference}/peripherals/gpio.rst | 0 doc/{api => reference}/peripherals/i2c.rst | 0 .../peripherals/i2c_eeprom_slave.rst | 0 doc/{api => reference}/peripherals/i2s.rst | 0 doc/{api => reference}/peripherals/index.rst | 0 doc/{api => reference}/peripherals/ipm.rst | 0 doc/{api => reference}/peripherals/pinmux.rst | 0 doc/{api => reference}/peripherals/pwm.rst | 0 doc/{api => reference}/peripherals/sensor.rst | 0 doc/{api => reference}/peripherals/spi.rst | 0 doc/{api => reference}/peripherals/uart.rst | 0 .../peripherals/watchdog.rst | 0 .../power_management/index.rst} | 0 .../shell/images/dynamic_cmd.PNG | Bin .../shell/images/static_cmd.PNG | Bin .../shell/images/wildcard.png | Bin .../shell.rst => reference/shell/index.rst} | 0 .../storage}/disk/sdhc.rst | 0 .../storage/index.rst} | 0 .../storage}/nvs/nvs.rst | 0 .../storage}/settings/settings.rst | 0 .../usb/usb.rst => reference/usb/index.rst} | 0 doc/user_guides.rst | 23 ----------------- 181 files changed, 73 insertions(+), 97 deletions(-) delete mode 100644 .known-issues/doc/kernel.conf rename doc/{subsystems => guides}/bluetooth/gap-pics.rst (100%) rename doc/{subsystems => guides}/bluetooth/gatt-pics.rst (100%) rename doc/{subsystems => guides}/bluetooth/index.rst (100%) rename doc/{subsystems => guides}/bluetooth/l2cap-pics.rst (100%) rename doc/{subsystems => guides}/bluetooth/rfcomm-pics.rst (100%) rename doc/{subsystems => guides}/bluetooth/sm-pics.rst (100%) rename doc/{subsystems => guides}/c_library.rst (100%) rename doc/{tools => guides}/coccinelle.rst (100%) rename doc/{tools => guides}/code-relocation.rst (100%) rename doc/{subsystems => guides/device_mgmt}/dfu.rst (100%) rename doc/{subsystems/mgmt.rst => guides/device_mgmt/index.rst} (100%) rename doc/{documentation/doc-guidelines.rst => guides/documentation/index.rst} (98%) rename doc/{devices => guides}/dts/flash_partitions.inc (100%) rename doc/{devices/dts/device_tree.rst => guides/dts/index.rst} (100%) create mode 100644 doc/guides/index.rst rename doc/{tools => guides}/kconfig/index.rst (100%) rename doc/{subsystems => guides}/networking/connectivity-example-app.c (100%) rename doc/{subsystems/networking/networking.rst => guides/networking/index.rst} (100%) rename doc/{subsystems => guides}/networking/ip-stack-architecture.dia (100%) rename doc/{subsystems => guides}/networking/ip-stack-architecture.png (100%) rename doc/{subsystems => guides}/networking/ip-stack-architecture.rst (100%) rename doc/{subsystems => guides}/networking/ip-stack-architecture.svg (100%) rename doc/{subsystems => guides}/networking/ip-stack-data-flow.dia (100%) rename doc/{subsystems => guides}/networking/ip-stack-data-flow.png (100%) rename doc/{subsystems => guides}/networking/ip-stack-data-flow.svg (100%) rename doc/{subsystems => guides}/networking/native_posix_setup.rst (100%) rename doc/{subsystems => guides}/networking/networking-api-usage.rst (100%) rename doc/{subsystems => guides}/networking/overview.rst (100%) rename doc/{subsystems => guides}/networking/qemu_setup.rst (100%) rename doc/{subsystems => guides}/networking/usbnet_setup.rst (100%) rename doc/{ => guides}/porting/arch.rst (100%) rename doc/{ => guides}/porting/board/hierarchy.png (100%) rename doc/{ => guides}/porting/board_porting.rst (100%) rename doc/{ => guides}/porting/cmsis_rtos_v1.rst (100%) rename doc/{ => guides}/porting/cmsis_rtos_v2.rst (100%) rename doc/{ => guides}/porting/index.rst (100%) rename doc/{ => guides}/porting/porting_to_zephyr.rst (100%) rename doc/{ => guides}/porting/shields.rst (100%) rename doc/{subsystems => guides}/test/index.rst (100%) rename doc/{subsystems => guides}/test/mocking.c (100%) rename doc/{subsystems => guides}/test/sanitycheck.rst (100%) rename doc/{subsystems => guides}/test/ztest.rst (100%) rename doc/{ => guides}/tools/nordic_segger.rst (100%) rename doc/{ => guides}/tools/opensda.rst (100%) rename doc/{ => guides}/tools/stlink-v21.rst (100%) rename doc/{subsystems => guides}/tracing/ctf.rst (100%) rename doc/{subsystems => guides}/tracing/index.rst (100%) rename doc/{tools => guides}/west/flash-debug.rst (100%) rename doc/{tools => guides}/west/index.rst (100%) rename doc/{tools => guides}/west/planned.rst (100%) rename doc/{tools => guides}/west/repo-tool.rst (100%) rename doc/{tools => guides}/west/west-apis.rst (100%) rename doc/{tools => guides}/west/west-mr-model.png (100%) rename doc/{tools => guides}/west/west-not-found.rst (100%) rename doc/{tools => guides}/west/why.rst (100%) rename doc/{tools => guides}/west/without-west.rst (100%) delete mode 100644 doc/reference.rst rename doc/{api => reference}/bluetooth/connection_mgmt.rst (100%) rename doc/{api => reference}/bluetooth/controller.rst (100%) rename doc/{api => reference}/bluetooth/crypto.rst (100%) rename doc/{api => reference}/bluetooth/data_buffer.rst (100%) rename doc/{api => reference}/bluetooth/gap.rst (100%) rename doc/{api => reference}/bluetooth/gatt.rst (100%) rename doc/{api => reference}/bluetooth/hci.txt (100%) rename doc/{api => reference}/bluetooth/hci_drivers.rst (100%) rename doc/{api => reference}/bluetooth/hci_raw.rst (100%) rename doc/{api => reference}/bluetooth/hfp.rst (100%) rename doc/{api => reference}/bluetooth/index.rst (100%) rename doc/{api => reference}/bluetooth/l2cap.rst (100%) rename doc/{api => reference}/bluetooth/mesh.rst (100%) rename doc/{api => reference}/bluetooth/rfcomm.rst (100%) rename doc/{api => reference}/bluetooth/sdp.rst (100%) rename doc/{api => reference}/bluetooth/uuid.rst (100%) rename doc/{api/display_api.rst => reference/display/index.rst} (100%) rename doc/{devices/drivers/drivers.rst => reference/drivers/index.rst} (100%) rename doc/{api/file_system.rst => reference/file_system/index.rst} (100%) create mode 100644 doc/reference/index.rst rename doc/{ => reference}/kernel/data_passing/fifos.rst (100%) rename doc/{ => reference}/kernel/data_passing/lifos.rst (100%) rename doc/{ => reference}/kernel/data_passing/mailboxes.rst (100%) rename doc/{ => reference}/kernel/data_passing/message_queues.rst (100%) rename doc/{ => reference}/kernel/data_passing/pipes.rst (100%) rename doc/{ => reference}/kernel/data_passing/stacks.rst (100%) rename doc/{kernel/kernel.rst => reference/kernel/index.rst} (100%) rename doc/{ => reference}/kernel/memory/heap.rst (100%) rename doc/{ => reference}/kernel/memory/pools.rst (100%) rename doc/{ => reference}/kernel/memory/slabs.rst (100%) rename doc/{ => reference}/kernel/other/atomic.rst (100%) rename doc/{ => reference}/kernel/other/cpu_idle.rst (100%) rename doc/{ => reference}/kernel/other/cxx_support.rst (100%) rename doc/{ => reference}/kernel/other/float.rst (100%) rename doc/{ => reference}/kernel/other/interrupts.rst (100%) rename doc/{ => reference}/kernel/other/polling.rst (100%) rename doc/{ => reference}/kernel/other/ring_buffers.rst (100%) rename doc/{ => reference}/kernel/other/version.rst (100%) rename doc/{ => reference}/kernel/synchronization/mutexes.rst (100%) rename doc/{ => reference}/kernel/synchronization/semaphores.rst (100%) rename doc/{ => reference}/kernel/threads/index.rst (100%) rename doc/{ => reference}/kernel/timing/clocks.rst (100%) rename doc/{ => reference}/kernel/timing/timers.rst (100%) rename doc/{ => reference}/kernel/usermode/kernelobjects.rst (100%) rename doc/{ => reference}/kernel/usermode/memory_domain.rst (100%) rename doc/{ => reference}/kernel/usermode/mpu_stack_objects.rst (100%) rename doc/{ => reference}/kernel/usermode/mpu_userspace.rst (100%) rename doc/{ => reference}/kernel/usermode/syscalls.rst (100%) rename doc/{ => reference}/kernel/usermode/usermode.rst (100%) rename doc/{ => reference}/kernel/usermode/usermode_sharedmem.rst (100%) rename doc/{subsystems => reference}/logging/index.rst (100%) rename doc/{subsystems => reference}/logging/system_log.rst (100%) rename doc/{api/misc_api.rst => reference/misc/index.rst} (100%) rename doc/{api => reference}/networking/coap.rst (100%) rename doc/{api => reference}/networking/dhcpv4.rst (100%) rename doc/{api => reference}/networking/dns_resolve.rst (100%) rename doc/{api => reference}/networking/ethernet.rst (100%) rename doc/{api => reference}/networking/ethernet_mgmt.rst (100%) rename doc/{api => reference}/networking/gptp.rst (100%) rename doc/{api => reference}/networking/ieee802154.rst (100%) rename doc/{api => reference}/networking/index.rst (100%) rename doc/{api => reference}/networking/ip_4_6.rst (100%) rename doc/{api => reference}/networking/lldp.rst (100%) rename doc/{api => reference}/networking/lwm2m.rst (100%) rename doc/{api => reference}/networking/mqtt.rst (100%) rename doc/{api => reference}/networking/net_buf.rst (100%) rename doc/{api => reference}/networking/net_config.rst (100%) rename doc/{api => reference}/networking/net_context.rst (100%) rename doc/{api => reference}/networking/net_core.rst (100%) rename doc/{api => reference}/networking/net_hostname.rst (100%) rename doc/{api => reference}/networking/net_if.rst (100%) rename doc/{api => reference}/networking/net_l2.rst (100%) rename doc/{api => reference}/networking/net_linkaddr.rst (100%) rename doc/{api => reference}/networking/net_mgmt.rst (100%) rename doc/{api => reference}/networking/net_offload.rst (100%) rename doc/{api => reference}/networking/net_pkt.rst (100%) rename doc/{api => reference}/networking/net_stats.rst (100%) rename doc/{api => reference}/networking/net_tech.rst (100%) rename doc/{api => reference}/networking/net_timeout.rst (100%) rename doc/{api => reference}/networking/promiscuous.rst (100%) rename doc/{api => reference}/networking/protocols.rst (100%) rename doc/{api => reference}/networking/ptp_time.rst (100%) rename doc/{api => reference}/networking/sockets.rst (100%) rename doc/{api => reference}/networking/traffic-class.rst (100%) rename doc/{api => reference}/networking/trickle.rst (100%) rename doc/{api => reference}/networking/udp.rst (100%) rename doc/{api => reference}/networking/vlan.rst (100%) rename doc/{api => reference}/peripherals/adc.rst (100%) rename doc/{api => reference}/peripherals/can.rst (100%) rename doc/{api => reference}/peripherals/counter.rst (100%) rename doc/{api => reference}/peripherals/dma.rst (100%) rename doc/{api => reference}/peripherals/entropy.rst (100%) rename doc/{api => reference}/peripherals/flash.rst (100%) rename doc/{api => reference}/peripherals/gpio.rst (100%) rename doc/{api => reference}/peripherals/i2c.rst (100%) rename doc/{api => reference}/peripherals/i2c_eeprom_slave.rst (100%) rename doc/{api => reference}/peripherals/i2s.rst (100%) rename doc/{api => reference}/peripherals/index.rst (100%) rename doc/{api => reference}/peripherals/ipm.rst (100%) rename doc/{api => reference}/peripherals/pinmux.rst (100%) rename doc/{api => reference}/peripherals/pwm.rst (100%) rename doc/{api => reference}/peripherals/sensor.rst (100%) rename doc/{api => reference}/peripherals/spi.rst (100%) rename doc/{api => reference}/peripherals/uart.rst (100%) rename doc/{api => reference}/peripherals/watchdog.rst (100%) rename doc/{subsystems/power_management.rst => reference/power_management/index.rst} (100%) rename doc/{subsystems => reference}/shell/images/dynamic_cmd.PNG (100%) rename doc/{subsystems => reference}/shell/images/static_cmd.PNG (100%) rename doc/{subsystems => reference}/shell/images/wildcard.png (100%) rename doc/{subsystems/shell/shell.rst => reference/shell/index.rst} (100%) rename doc/{subsystems => reference/storage}/disk/sdhc.rst (100%) rename doc/{subsystems/storage.rst => reference/storage/index.rst} (100%) rename doc/{subsystems => reference/storage}/nvs/nvs.rst (100%) rename doc/{subsystems => reference/storage}/settings/settings.rst (100%) rename doc/{subsystems/usb/usb.rst => reference/usb/index.rst} (100%) delete mode 100644 doc/user_guides.rst diff --git a/.known-issues/doc/bluetooth.conf b/.known-issues/doc/bluetooth.conf index d76b1fc114..23ea8237aa 100644 --- a/.known-issues/doc/bluetooth.conf +++ b/.known-issues/doc/bluetooth.conf @@ -3,7 +3,7 @@ # # FIXME: all these should match the relative filename # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]$ +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]$ ^[ \t]*$ ^[ \t]*\^$ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+]$ @@ -15,7 +15,7 @@ # # bt_gatt_discover_params unnamed struct definition # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -27,7 +27,7 @@ # # Bluetooth GATT unnamed struct definition # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -39,7 +39,7 @@ # # Bluetooth mesh unnamed struct definition # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]bluetooth.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] diff --git a/.known-issues/doc/display.conf b/.known-issues/doc/display.conf index b37c89370d..50d07de818 100644 --- a/.known-issues/doc/display.conf +++ b/.known-issues/doc/display.conf @@ -4,7 +4,7 @@ # # include # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]display_api.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]display_api.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] diff --git a/.known-issues/doc/duplicate.conf b/.known-issues/doc/duplicate.conf index 7ed3c0d33b..8e51c2b982 100644 --- a/.known-issues/doc/duplicate.conf +++ b/.known-issues/doc/duplicate.conf @@ -1,6 +1,6 @@ # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]file_system.rst):(?P[0-9]+): WARNING: Duplicate declaration. +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]file_system[/\\]index.rst):(?P[0-9]+): WARNING: Duplicate declaration. # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]dma.rst):(?P[0-9]+): WARNING: Duplicate declaration. +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]peripherals[/\\]dma.rst):(?P[0-9]+): WARNING: Duplicate declaration. # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]sensor.rst):(?P[0-9]+): WARNING: Duplicate declaration. +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]peripherals[/\\]sensor.rst):(?P[0-9]+): WARNING: Duplicate declaration. diff --git a/.known-issues/doc/kernel.conf b/.known-issues/doc/kernel.conf deleted file mode 100644 index 901b6fd467..0000000000 --- a/.known-issues/doc/kernel.conf +++ /dev/null @@ -1,24 +0,0 @@ -# -# Kernel -# -# -# include/kernel.h warnings -# -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]kernel_api.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] -^[ \t]* -^[ \t]*\^ -^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] -^[ \t]* -^[ \t]*\^ -^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] -^[ \t]* -^[ \t]*\^ -^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] -^[ \t]* -^[ \t]*\^ -^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] -^[ \t]* -^[ \t]*\^ -^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+] -^.*k_poll_event.__unnamed__ -^[- \t]*\^ diff --git a/.known-issues/doc/misc.conf b/.known-issues/doc/misc.conf index 29adce593e..48323bee0b 100644 --- a/.known-issues/doc/misc.conf +++ b/.known-issues/doc/misc.conf @@ -4,7 +4,7 @@ # # include # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]misc_api.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]misc_api.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] diff --git a/.known-issues/doc/networking.conf b/.known-issues/doc/networking.conf index 897fc5dc9d..300be1e826 100644 --- a/.known-issues/doc/networking.conf +++ b/.known-issues/doc/networking.conf @@ -4,7 +4,7 @@ # # include/net/net_ip.h warnings # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -19,7 +19,7 @@ # # include/net/net_mgmt.h # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -31,7 +31,7 @@ # # include/net/buf.h # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -43,7 +43,7 @@ # # include/net/ieee802154.h # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -55,16 +55,16 @@ # # include/net/net_context.h # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking[/\\]net_context.rst):(?P[0-9]+): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking[/\\]net_context.rst):(?P[0-9]+): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+] ^.*net_context.options ^[- \t]*\^ # # include/net/net_stats.h # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking[/\\]net_stats.rst):(?P[0-9]+): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking[/\\]net_stats.rst):(?P[0-9]+): WARNING: Invalid definition: Expected end of definition. \[error at [0-9]+] ^.*net_stats_tc.[a-z]+ ^[- \t]*\^ # # stray duplicate definition warnings # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]networking[/\\]net_if.rst):(?P[0-9]+): WARNING: Duplicate declaration. +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]networking[/\\]net_if.rst):(?P[0-9]+): WARNING: Duplicate declaration. diff --git a/.known-issues/doc/uart.conf b/.known-issues/doc/uart.conf index f66b0f3229..002f12acd2 100644 --- a/.known-issues/doc/uart.conf +++ b/.known-issues/doc/uart.conf @@ -1,7 +1,7 @@ # # UART unnamed struct definition #doc/api/peripherals/uart.rst -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]uart.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]peripherals[/\\]uart.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] @@ -14,7 +14,7 @@ ^.*uart_device_config.__unnamed__.* ^[- \t]*\^ # -^(?P([\-:\\/\w\.])+[/\\]doc[/\\]api[/\\]peripherals[/\\]uart.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] +^(?P([\-:\\/\w\.])+[/\\]doc[/\\]reference[/\\]peripherals[/\\]uart.rst):(?P[0-9]+): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] ^[ \t]* ^[ \t]*\^ ^(?P=filename):(?P=lineno): WARNING: Invalid definition: Expected identifier in nested name. \[error at [0-9]+] diff --git a/doc/subsystems/bluetooth/gap-pics.rst b/doc/guides/bluetooth/gap-pics.rst similarity index 100% rename from doc/subsystems/bluetooth/gap-pics.rst rename to doc/guides/bluetooth/gap-pics.rst diff --git a/doc/subsystems/bluetooth/gatt-pics.rst b/doc/guides/bluetooth/gatt-pics.rst similarity index 100% rename from doc/subsystems/bluetooth/gatt-pics.rst rename to doc/guides/bluetooth/gatt-pics.rst diff --git a/doc/subsystems/bluetooth/index.rst b/doc/guides/bluetooth/index.rst similarity index 100% rename from doc/subsystems/bluetooth/index.rst rename to doc/guides/bluetooth/index.rst diff --git a/doc/subsystems/bluetooth/l2cap-pics.rst b/doc/guides/bluetooth/l2cap-pics.rst similarity index 100% rename from doc/subsystems/bluetooth/l2cap-pics.rst rename to doc/guides/bluetooth/l2cap-pics.rst diff --git a/doc/subsystems/bluetooth/rfcomm-pics.rst b/doc/guides/bluetooth/rfcomm-pics.rst similarity index 100% rename from doc/subsystems/bluetooth/rfcomm-pics.rst rename to doc/guides/bluetooth/rfcomm-pics.rst diff --git a/doc/subsystems/bluetooth/sm-pics.rst b/doc/guides/bluetooth/sm-pics.rst similarity index 100% rename from doc/subsystems/bluetooth/sm-pics.rst rename to doc/guides/bluetooth/sm-pics.rst diff --git a/doc/subsystems/c_library.rst b/doc/guides/c_library.rst similarity index 100% rename from doc/subsystems/c_library.rst rename to doc/guides/c_library.rst diff --git a/doc/tools/coccinelle.rst b/doc/guides/coccinelle.rst similarity index 100% rename from doc/tools/coccinelle.rst rename to doc/guides/coccinelle.rst diff --git a/doc/tools/code-relocation.rst b/doc/guides/code-relocation.rst similarity index 100% rename from doc/tools/code-relocation.rst rename to doc/guides/code-relocation.rst diff --git a/doc/subsystems/dfu.rst b/doc/guides/device_mgmt/dfu.rst similarity index 100% rename from doc/subsystems/dfu.rst rename to doc/guides/device_mgmt/dfu.rst diff --git a/doc/subsystems/mgmt.rst b/doc/guides/device_mgmt/index.rst similarity index 100% rename from doc/subsystems/mgmt.rst rename to doc/guides/device_mgmt/index.rst diff --git a/doc/documentation/doc-guidelines.rst b/doc/guides/documentation/index.rst similarity index 98% rename from doc/documentation/doc-guidelines.rst rename to doc/guides/documentation/index.rst index 95ae049f7c..e4ccc2bc89 100644 --- a/doc/documentation/doc-guidelines.rst +++ b/doc/guides/documentation/index.rst @@ -320,7 +320,7 @@ of the reST files. The names of these replacement characters are the same as us entities used to insert characters in HTML, e.g., \™ and are defined in the file ``sphinx_build/substitutions.txt`` as listed here: -.. literalinclude:: ../substitutions.txt +.. literalinclude:: ../../substitutions.txt :language: rst We've kept the substitutions list small but others can be added as @@ -390,13 +390,13 @@ Images Images are included in documentation by using an image directive:: - .. image:: ../images/doc-gen-flow.png + .. image:: ../../images/doc-gen-flow.png :align: center :alt: alt text for the image or if you'd like to add an image caption, use:: - .. figure:: ../images/doc-gen-flow.png + .. figure:: ../../images/doc-gen-flow.png :alt: image description Caption for the figure @@ -435,7 +435,7 @@ are an allowed exception. zephyr-app-commands Directive ***************************** -.. include:: ../extensions/zephyr/application.py +.. include:: ../../extensions/zephyr/application.py :start-line: 10 :start-after: ''' :end-before: ''' diff --git a/doc/devices/dts/flash_partitions.inc b/doc/guides/dts/flash_partitions.inc similarity index 100% rename from doc/devices/dts/flash_partitions.inc rename to doc/guides/dts/flash_partitions.inc diff --git a/doc/devices/dts/device_tree.rst b/doc/guides/dts/index.rst similarity index 100% rename from doc/devices/dts/device_tree.rst rename to doc/guides/dts/index.rst diff --git a/doc/guides/index.rst b/doc/guides/index.rst new file mode 100644 index 0000000000..e357d04e92 --- /dev/null +++ b/doc/guides/index.rst @@ -0,0 +1,23 @@ +.. _user_guides: + +User and Developer Guides +######################### + +.. toctree:: + :maxdepth: 1 + + bluetooth/index.rst + c_library + ../README.rst + coccinelle.rst + code-relocation.rst + device_mgmt/index + device_mgmt/dfu + documentation/index + dts/index + kconfig/index + networking/index + porting/index + test/index + tracing/index + west/index diff --git a/doc/tools/kconfig/index.rst b/doc/guides/kconfig/index.rst similarity index 100% rename from doc/tools/kconfig/index.rst rename to doc/guides/kconfig/index.rst diff --git a/doc/subsystems/networking/connectivity-example-app.c b/doc/guides/networking/connectivity-example-app.c similarity index 100% rename from doc/subsystems/networking/connectivity-example-app.c rename to doc/guides/networking/connectivity-example-app.c diff --git a/doc/subsystems/networking/networking.rst b/doc/guides/networking/index.rst similarity index 100% rename from doc/subsystems/networking/networking.rst rename to doc/guides/networking/index.rst diff --git a/doc/subsystems/networking/ip-stack-architecture.dia b/doc/guides/networking/ip-stack-architecture.dia similarity index 100% rename from doc/subsystems/networking/ip-stack-architecture.dia rename to doc/guides/networking/ip-stack-architecture.dia diff --git a/doc/subsystems/networking/ip-stack-architecture.png b/doc/guides/networking/ip-stack-architecture.png similarity index 100% rename from doc/subsystems/networking/ip-stack-architecture.png rename to doc/guides/networking/ip-stack-architecture.png diff --git a/doc/subsystems/networking/ip-stack-architecture.rst b/doc/guides/networking/ip-stack-architecture.rst similarity index 100% rename from doc/subsystems/networking/ip-stack-architecture.rst rename to doc/guides/networking/ip-stack-architecture.rst diff --git a/doc/subsystems/networking/ip-stack-architecture.svg b/doc/guides/networking/ip-stack-architecture.svg similarity index 100% rename from doc/subsystems/networking/ip-stack-architecture.svg rename to doc/guides/networking/ip-stack-architecture.svg diff --git a/doc/subsystems/networking/ip-stack-data-flow.dia b/doc/guides/networking/ip-stack-data-flow.dia similarity index 100% rename from doc/subsystems/networking/ip-stack-data-flow.dia rename to doc/guides/networking/ip-stack-data-flow.dia diff --git a/doc/subsystems/networking/ip-stack-data-flow.png b/doc/guides/networking/ip-stack-data-flow.png similarity index 100% rename from doc/subsystems/networking/ip-stack-data-flow.png rename to doc/guides/networking/ip-stack-data-flow.png diff --git a/doc/subsystems/networking/ip-stack-data-flow.svg b/doc/guides/networking/ip-stack-data-flow.svg similarity index 100% rename from doc/subsystems/networking/ip-stack-data-flow.svg rename to doc/guides/networking/ip-stack-data-flow.svg diff --git a/doc/subsystems/networking/native_posix_setup.rst b/doc/guides/networking/native_posix_setup.rst similarity index 100% rename from doc/subsystems/networking/native_posix_setup.rst rename to doc/guides/networking/native_posix_setup.rst diff --git a/doc/subsystems/networking/networking-api-usage.rst b/doc/guides/networking/networking-api-usage.rst similarity index 100% rename from doc/subsystems/networking/networking-api-usage.rst rename to doc/guides/networking/networking-api-usage.rst diff --git a/doc/subsystems/networking/overview.rst b/doc/guides/networking/overview.rst similarity index 100% rename from doc/subsystems/networking/overview.rst rename to doc/guides/networking/overview.rst diff --git a/doc/subsystems/networking/qemu_setup.rst b/doc/guides/networking/qemu_setup.rst similarity index 100% rename from doc/subsystems/networking/qemu_setup.rst rename to doc/guides/networking/qemu_setup.rst diff --git a/doc/subsystems/networking/usbnet_setup.rst b/doc/guides/networking/usbnet_setup.rst similarity index 100% rename from doc/subsystems/networking/usbnet_setup.rst rename to doc/guides/networking/usbnet_setup.rst diff --git a/doc/porting/arch.rst b/doc/guides/porting/arch.rst similarity index 100% rename from doc/porting/arch.rst rename to doc/guides/porting/arch.rst diff --git a/doc/porting/board/hierarchy.png b/doc/guides/porting/board/hierarchy.png similarity index 100% rename from doc/porting/board/hierarchy.png rename to doc/guides/porting/board/hierarchy.png diff --git a/doc/porting/board_porting.rst b/doc/guides/porting/board_porting.rst similarity index 100% rename from doc/porting/board_porting.rst rename to doc/guides/porting/board_porting.rst diff --git a/doc/porting/cmsis_rtos_v1.rst b/doc/guides/porting/cmsis_rtos_v1.rst similarity index 100% rename from doc/porting/cmsis_rtos_v1.rst rename to doc/guides/porting/cmsis_rtos_v1.rst diff --git a/doc/porting/cmsis_rtos_v2.rst b/doc/guides/porting/cmsis_rtos_v2.rst similarity index 100% rename from doc/porting/cmsis_rtos_v2.rst rename to doc/guides/porting/cmsis_rtos_v2.rst diff --git a/doc/porting/index.rst b/doc/guides/porting/index.rst similarity index 100% rename from doc/porting/index.rst rename to doc/guides/porting/index.rst diff --git a/doc/porting/porting_to_zephyr.rst b/doc/guides/porting/porting_to_zephyr.rst similarity index 100% rename from doc/porting/porting_to_zephyr.rst rename to doc/guides/porting/porting_to_zephyr.rst diff --git a/doc/porting/shields.rst b/doc/guides/porting/shields.rst similarity index 100% rename from doc/porting/shields.rst rename to doc/guides/porting/shields.rst diff --git a/doc/subsystems/test/index.rst b/doc/guides/test/index.rst similarity index 100% rename from doc/subsystems/test/index.rst rename to doc/guides/test/index.rst diff --git a/doc/subsystems/test/mocking.c b/doc/guides/test/mocking.c similarity index 100% rename from doc/subsystems/test/mocking.c rename to doc/guides/test/mocking.c diff --git a/doc/subsystems/test/sanitycheck.rst b/doc/guides/test/sanitycheck.rst similarity index 100% rename from doc/subsystems/test/sanitycheck.rst rename to doc/guides/test/sanitycheck.rst diff --git a/doc/subsystems/test/ztest.rst b/doc/guides/test/ztest.rst similarity index 100% rename from doc/subsystems/test/ztest.rst rename to doc/guides/test/ztest.rst diff --git a/doc/tools/nordic_segger.rst b/doc/guides/tools/nordic_segger.rst similarity index 100% rename from doc/tools/nordic_segger.rst rename to doc/guides/tools/nordic_segger.rst diff --git a/doc/tools/opensda.rst b/doc/guides/tools/opensda.rst similarity index 100% rename from doc/tools/opensda.rst rename to doc/guides/tools/opensda.rst diff --git a/doc/tools/stlink-v21.rst b/doc/guides/tools/stlink-v21.rst similarity index 100% rename from doc/tools/stlink-v21.rst rename to doc/guides/tools/stlink-v21.rst diff --git a/doc/subsystems/tracing/ctf.rst b/doc/guides/tracing/ctf.rst similarity index 100% rename from doc/subsystems/tracing/ctf.rst rename to doc/guides/tracing/ctf.rst diff --git a/doc/subsystems/tracing/index.rst b/doc/guides/tracing/index.rst similarity index 100% rename from doc/subsystems/tracing/index.rst rename to doc/guides/tracing/index.rst diff --git a/doc/tools/west/flash-debug.rst b/doc/guides/west/flash-debug.rst similarity index 100% rename from doc/tools/west/flash-debug.rst rename to doc/guides/west/flash-debug.rst diff --git a/doc/tools/west/index.rst b/doc/guides/west/index.rst similarity index 100% rename from doc/tools/west/index.rst rename to doc/guides/west/index.rst diff --git a/doc/tools/west/planned.rst b/doc/guides/west/planned.rst similarity index 100% rename from doc/tools/west/planned.rst rename to doc/guides/west/planned.rst diff --git a/doc/tools/west/repo-tool.rst b/doc/guides/west/repo-tool.rst similarity index 100% rename from doc/tools/west/repo-tool.rst rename to doc/guides/west/repo-tool.rst diff --git a/doc/tools/west/west-apis.rst b/doc/guides/west/west-apis.rst similarity index 100% rename from doc/tools/west/west-apis.rst rename to doc/guides/west/west-apis.rst diff --git a/doc/tools/west/west-mr-model.png b/doc/guides/west/west-mr-model.png similarity index 100% rename from doc/tools/west/west-mr-model.png rename to doc/guides/west/west-mr-model.png diff --git a/doc/tools/west/west-not-found.rst b/doc/guides/west/west-not-found.rst similarity index 100% rename from doc/tools/west/west-not-found.rst rename to doc/guides/west/west-not-found.rst diff --git a/doc/tools/west/why.rst b/doc/guides/west/why.rst similarity index 100% rename from doc/tools/west/why.rst rename to doc/guides/west/why.rst diff --git a/doc/tools/west/without-west.rst b/doc/guides/west/without-west.rst similarity index 100% rename from doc/tools/west/without-west.rst rename to doc/guides/west/without-west.rst diff --git a/doc/index.rst b/doc/index.rst index 17c69071e5..d3e7d44d03 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -49,7 +49,7 @@ licensing, as described in :ref:`Zephyr_Licensing`. system, and then build and run a sample application.

  • - +

    Contribution Guidelines

     @@ -65,7 +65,7 @@ licensing, as described in :ref:`Zephyr_Licensing`. by Zephyr

  • - +

    API Reference

     @@ -86,7 +86,7 @@ licensing, as described in :ref:`Zephyr_Licensing`.

    List if supported boards and platforms.

  • - +

    User and Developer Guides

     @@ -107,8 +107,8 @@ licensing, as described in :ref:`Zephyr_Licensing`. contribute/index.rst development_process/index.rst application/application.rst - reference.rst - user_guides.rst + reference/index.rst + guides/index.rst security/security.rst samples/samples.rst boards/boards.rst diff --git a/doc/reference.rst b/doc/reference.rst deleted file mode 100644 index 5286d4d17f..0000000000 --- a/doc/reference.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _api_reference: - -API Reference -############# - -.. toctree:: - :maxdepth: 1 - - api/bluetooth/index.rst - reference/kconfig/index.rst - devices/drivers/drivers.rst - api/display_api - api/file_system - kernel/kernel.rst - subsystems/logging/index - api/misc_api - api/networking/index - api/peripherals/index.rst - subsystems/power_management.rst - subsystems/shell/shell - subsystems/storage.rst - subsystems/usb/usb.rst - diff --git a/doc/api/bluetooth/connection_mgmt.rst b/doc/reference/bluetooth/connection_mgmt.rst similarity index 100% rename from doc/api/bluetooth/connection_mgmt.rst rename to doc/reference/bluetooth/connection_mgmt.rst diff --git a/doc/api/bluetooth/controller.rst b/doc/reference/bluetooth/controller.rst similarity index 100% rename from doc/api/bluetooth/controller.rst rename to doc/reference/bluetooth/controller.rst diff --git a/doc/api/bluetooth/crypto.rst b/doc/reference/bluetooth/crypto.rst similarity index 100% rename from doc/api/bluetooth/crypto.rst rename to doc/reference/bluetooth/crypto.rst diff --git a/doc/api/bluetooth/data_buffer.rst b/doc/reference/bluetooth/data_buffer.rst similarity index 100% rename from doc/api/bluetooth/data_buffer.rst rename to doc/reference/bluetooth/data_buffer.rst diff --git a/doc/api/bluetooth/gap.rst b/doc/reference/bluetooth/gap.rst similarity index 100% rename from doc/api/bluetooth/gap.rst rename to doc/reference/bluetooth/gap.rst diff --git a/doc/api/bluetooth/gatt.rst b/doc/reference/bluetooth/gatt.rst similarity index 100% rename from doc/api/bluetooth/gatt.rst rename to doc/reference/bluetooth/gatt.rst diff --git a/doc/api/bluetooth/hci.txt b/doc/reference/bluetooth/hci.txt similarity index 100% rename from doc/api/bluetooth/hci.txt rename to doc/reference/bluetooth/hci.txt diff --git a/doc/api/bluetooth/hci_drivers.rst b/doc/reference/bluetooth/hci_drivers.rst similarity index 100% rename from doc/api/bluetooth/hci_drivers.rst rename to doc/reference/bluetooth/hci_drivers.rst diff --git a/doc/api/bluetooth/hci_raw.rst b/doc/reference/bluetooth/hci_raw.rst similarity index 100% rename from doc/api/bluetooth/hci_raw.rst rename to doc/reference/bluetooth/hci_raw.rst diff --git a/doc/api/bluetooth/hfp.rst b/doc/reference/bluetooth/hfp.rst similarity index 100% rename from doc/api/bluetooth/hfp.rst rename to doc/reference/bluetooth/hfp.rst diff --git a/doc/api/bluetooth/index.rst b/doc/reference/bluetooth/index.rst similarity index 100% rename from doc/api/bluetooth/index.rst rename to doc/reference/bluetooth/index.rst diff --git a/doc/api/bluetooth/l2cap.rst b/doc/reference/bluetooth/l2cap.rst similarity index 100% rename from doc/api/bluetooth/l2cap.rst rename to doc/reference/bluetooth/l2cap.rst diff --git a/doc/api/bluetooth/mesh.rst b/doc/reference/bluetooth/mesh.rst similarity index 100% rename from doc/api/bluetooth/mesh.rst rename to doc/reference/bluetooth/mesh.rst diff --git a/doc/api/bluetooth/rfcomm.rst b/doc/reference/bluetooth/rfcomm.rst similarity index 100% rename from doc/api/bluetooth/rfcomm.rst rename to doc/reference/bluetooth/rfcomm.rst diff --git a/doc/api/bluetooth/sdp.rst b/doc/reference/bluetooth/sdp.rst similarity index 100% rename from doc/api/bluetooth/sdp.rst rename to doc/reference/bluetooth/sdp.rst diff --git a/doc/api/bluetooth/uuid.rst b/doc/reference/bluetooth/uuid.rst similarity index 100% rename from doc/api/bluetooth/uuid.rst rename to doc/reference/bluetooth/uuid.rst diff --git a/doc/api/display_api.rst b/doc/reference/display/index.rst similarity index 100% rename from doc/api/display_api.rst rename to doc/reference/display/index.rst diff --git a/doc/devices/drivers/drivers.rst b/doc/reference/drivers/index.rst similarity index 100% rename from doc/devices/drivers/drivers.rst rename to doc/reference/drivers/index.rst diff --git a/doc/api/file_system.rst b/doc/reference/file_system/index.rst similarity index 100% rename from doc/api/file_system.rst rename to doc/reference/file_system/index.rst diff --git a/doc/reference/index.rst b/doc/reference/index.rst new file mode 100644 index 0000000000..62550510a6 --- /dev/null +++ b/doc/reference/index.rst @@ -0,0 +1,23 @@ +.. _api_reference: + +API Reference +############# + +.. toctree:: + :maxdepth: 1 + + bluetooth/index.rst + kconfig/index.rst + drivers/index.rst + display/index.rst + file_system/index.rst + kernel/index.rst + logging/index.rst + misc/index + networking/index.rst + peripherals/index.rst + power_management/index.rst + shell/index.rst + storage/index.rst + usb/index.rst + diff --git a/doc/kernel/data_passing/fifos.rst b/doc/reference/kernel/data_passing/fifos.rst similarity index 100% rename from doc/kernel/data_passing/fifos.rst rename to doc/reference/kernel/data_passing/fifos.rst diff --git a/doc/kernel/data_passing/lifos.rst b/doc/reference/kernel/data_passing/lifos.rst similarity index 100% rename from doc/kernel/data_passing/lifos.rst rename to doc/reference/kernel/data_passing/lifos.rst diff --git a/doc/kernel/data_passing/mailboxes.rst b/doc/reference/kernel/data_passing/mailboxes.rst similarity index 100% rename from doc/kernel/data_passing/mailboxes.rst rename to doc/reference/kernel/data_passing/mailboxes.rst diff --git a/doc/kernel/data_passing/message_queues.rst b/doc/reference/kernel/data_passing/message_queues.rst similarity index 100% rename from doc/kernel/data_passing/message_queues.rst rename to doc/reference/kernel/data_passing/message_queues.rst diff --git a/doc/kernel/data_passing/pipes.rst b/doc/reference/kernel/data_passing/pipes.rst similarity index 100% rename from doc/kernel/data_passing/pipes.rst rename to doc/reference/kernel/data_passing/pipes.rst diff --git a/doc/kernel/data_passing/stacks.rst b/doc/reference/kernel/data_passing/stacks.rst similarity index 100% rename from doc/kernel/data_passing/stacks.rst rename to doc/reference/kernel/data_passing/stacks.rst diff --git a/doc/kernel/kernel.rst b/doc/reference/kernel/index.rst similarity index 100% rename from doc/kernel/kernel.rst rename to doc/reference/kernel/index.rst diff --git a/doc/kernel/memory/heap.rst b/doc/reference/kernel/memory/heap.rst similarity index 100% rename from doc/kernel/memory/heap.rst rename to doc/reference/kernel/memory/heap.rst diff --git a/doc/kernel/memory/pools.rst b/doc/reference/kernel/memory/pools.rst similarity index 100% rename from doc/kernel/memory/pools.rst rename to doc/reference/kernel/memory/pools.rst diff --git a/doc/kernel/memory/slabs.rst b/doc/reference/kernel/memory/slabs.rst similarity index 100% rename from doc/kernel/memory/slabs.rst rename to doc/reference/kernel/memory/slabs.rst diff --git a/doc/kernel/other/atomic.rst b/doc/reference/kernel/other/atomic.rst similarity index 100% rename from doc/kernel/other/atomic.rst rename to doc/reference/kernel/other/atomic.rst diff --git a/doc/kernel/other/cpu_idle.rst b/doc/reference/kernel/other/cpu_idle.rst similarity index 100% rename from doc/kernel/other/cpu_idle.rst rename to doc/reference/kernel/other/cpu_idle.rst diff --git a/doc/kernel/other/cxx_support.rst b/doc/reference/kernel/other/cxx_support.rst similarity index 100% rename from doc/kernel/other/cxx_support.rst rename to doc/reference/kernel/other/cxx_support.rst diff --git a/doc/kernel/other/float.rst b/doc/reference/kernel/other/float.rst similarity index 100% rename from doc/kernel/other/float.rst rename to doc/reference/kernel/other/float.rst diff --git a/doc/kernel/other/interrupts.rst b/doc/reference/kernel/other/interrupts.rst similarity index 100% rename from doc/kernel/other/interrupts.rst rename to doc/reference/kernel/other/interrupts.rst diff --git a/doc/kernel/other/polling.rst b/doc/reference/kernel/other/polling.rst similarity index 100% rename from doc/kernel/other/polling.rst rename to doc/reference/kernel/other/polling.rst diff --git a/doc/kernel/other/ring_buffers.rst b/doc/reference/kernel/other/ring_buffers.rst similarity index 100% rename from doc/kernel/other/ring_buffers.rst rename to doc/reference/kernel/other/ring_buffers.rst diff --git a/doc/kernel/other/version.rst b/doc/reference/kernel/other/version.rst similarity index 100% rename from doc/kernel/other/version.rst rename to doc/reference/kernel/other/version.rst diff --git a/doc/kernel/synchronization/mutexes.rst b/doc/reference/kernel/synchronization/mutexes.rst similarity index 100% rename from doc/kernel/synchronization/mutexes.rst rename to doc/reference/kernel/synchronization/mutexes.rst diff --git a/doc/kernel/synchronization/semaphores.rst b/doc/reference/kernel/synchronization/semaphores.rst similarity index 100% rename from doc/kernel/synchronization/semaphores.rst rename to doc/reference/kernel/synchronization/semaphores.rst diff --git a/doc/kernel/threads/index.rst b/doc/reference/kernel/threads/index.rst similarity index 100% rename from doc/kernel/threads/index.rst rename to doc/reference/kernel/threads/index.rst diff --git a/doc/kernel/timing/clocks.rst b/doc/reference/kernel/timing/clocks.rst similarity index 100% rename from doc/kernel/timing/clocks.rst rename to doc/reference/kernel/timing/clocks.rst diff --git a/doc/kernel/timing/timers.rst b/doc/reference/kernel/timing/timers.rst similarity index 100% rename from doc/kernel/timing/timers.rst rename to doc/reference/kernel/timing/timers.rst diff --git a/doc/kernel/usermode/kernelobjects.rst b/doc/reference/kernel/usermode/kernelobjects.rst similarity index 100% rename from doc/kernel/usermode/kernelobjects.rst rename to doc/reference/kernel/usermode/kernelobjects.rst diff --git a/doc/kernel/usermode/memory_domain.rst b/doc/reference/kernel/usermode/memory_domain.rst similarity index 100% rename from doc/kernel/usermode/memory_domain.rst rename to doc/reference/kernel/usermode/memory_domain.rst diff --git a/doc/kernel/usermode/mpu_stack_objects.rst b/doc/reference/kernel/usermode/mpu_stack_objects.rst similarity index 100% rename from doc/kernel/usermode/mpu_stack_objects.rst rename to doc/reference/kernel/usermode/mpu_stack_objects.rst diff --git a/doc/kernel/usermode/mpu_userspace.rst b/doc/reference/kernel/usermode/mpu_userspace.rst similarity index 100% rename from doc/kernel/usermode/mpu_userspace.rst rename to doc/reference/kernel/usermode/mpu_userspace.rst diff --git a/doc/kernel/usermode/syscalls.rst b/doc/reference/kernel/usermode/syscalls.rst similarity index 100% rename from doc/kernel/usermode/syscalls.rst rename to doc/reference/kernel/usermode/syscalls.rst diff --git a/doc/kernel/usermode/usermode.rst b/doc/reference/kernel/usermode/usermode.rst similarity index 100% rename from doc/kernel/usermode/usermode.rst rename to doc/reference/kernel/usermode/usermode.rst diff --git a/doc/kernel/usermode/usermode_sharedmem.rst b/doc/reference/kernel/usermode/usermode_sharedmem.rst similarity index 100% rename from doc/kernel/usermode/usermode_sharedmem.rst rename to doc/reference/kernel/usermode/usermode_sharedmem.rst diff --git a/doc/subsystems/logging/index.rst b/doc/reference/logging/index.rst similarity index 100% rename from doc/subsystems/logging/index.rst rename to doc/reference/logging/index.rst diff --git a/doc/subsystems/logging/system_log.rst b/doc/reference/logging/system_log.rst similarity index 100% rename from doc/subsystems/logging/system_log.rst rename to doc/reference/logging/system_log.rst diff --git a/doc/api/misc_api.rst b/doc/reference/misc/index.rst similarity index 100% rename from doc/api/misc_api.rst rename to doc/reference/misc/index.rst diff --git a/doc/api/networking/coap.rst b/doc/reference/networking/coap.rst similarity index 100% rename from doc/api/networking/coap.rst rename to doc/reference/networking/coap.rst diff --git a/doc/api/networking/dhcpv4.rst b/doc/reference/networking/dhcpv4.rst similarity index 100% rename from doc/api/networking/dhcpv4.rst rename to doc/reference/networking/dhcpv4.rst diff --git a/doc/api/networking/dns_resolve.rst b/doc/reference/networking/dns_resolve.rst similarity index 100% rename from doc/api/networking/dns_resolve.rst rename to doc/reference/networking/dns_resolve.rst diff --git a/doc/api/networking/ethernet.rst b/doc/reference/networking/ethernet.rst similarity index 100% rename from doc/api/networking/ethernet.rst rename to doc/reference/networking/ethernet.rst diff --git a/doc/api/networking/ethernet_mgmt.rst b/doc/reference/networking/ethernet_mgmt.rst similarity index 100% rename from doc/api/networking/ethernet_mgmt.rst rename to doc/reference/networking/ethernet_mgmt.rst diff --git a/doc/api/networking/gptp.rst b/doc/reference/networking/gptp.rst similarity index 100% rename from doc/api/networking/gptp.rst rename to doc/reference/networking/gptp.rst diff --git a/doc/api/networking/ieee802154.rst b/doc/reference/networking/ieee802154.rst similarity index 100% rename from doc/api/networking/ieee802154.rst rename to doc/reference/networking/ieee802154.rst diff --git a/doc/api/networking/index.rst b/doc/reference/networking/index.rst similarity index 100% rename from doc/api/networking/index.rst rename to doc/reference/networking/index.rst diff --git a/doc/api/networking/ip_4_6.rst b/doc/reference/networking/ip_4_6.rst similarity index 100% rename from doc/api/networking/ip_4_6.rst rename to doc/reference/networking/ip_4_6.rst diff --git a/doc/api/networking/lldp.rst b/doc/reference/networking/lldp.rst similarity index 100% rename from doc/api/networking/lldp.rst rename to doc/reference/networking/lldp.rst diff --git a/doc/api/networking/lwm2m.rst b/doc/reference/networking/lwm2m.rst similarity index 100% rename from doc/api/networking/lwm2m.rst rename to doc/reference/networking/lwm2m.rst diff --git a/doc/api/networking/mqtt.rst b/doc/reference/networking/mqtt.rst similarity index 100% rename from doc/api/networking/mqtt.rst rename to doc/reference/networking/mqtt.rst diff --git a/doc/api/networking/net_buf.rst b/doc/reference/networking/net_buf.rst similarity index 100% rename from doc/api/networking/net_buf.rst rename to doc/reference/networking/net_buf.rst diff --git a/doc/api/networking/net_config.rst b/doc/reference/networking/net_config.rst similarity index 100% rename from doc/api/networking/net_config.rst rename to doc/reference/networking/net_config.rst diff --git a/doc/api/networking/net_context.rst b/doc/reference/networking/net_context.rst similarity index 100% rename from doc/api/networking/net_context.rst rename to doc/reference/networking/net_context.rst diff --git a/doc/api/networking/net_core.rst b/doc/reference/networking/net_core.rst similarity index 100% rename from doc/api/networking/net_core.rst rename to doc/reference/networking/net_core.rst diff --git a/doc/api/networking/net_hostname.rst b/doc/reference/networking/net_hostname.rst similarity index 100% rename from doc/api/networking/net_hostname.rst rename to doc/reference/networking/net_hostname.rst diff --git a/doc/api/networking/net_if.rst b/doc/reference/networking/net_if.rst similarity index 100% rename from doc/api/networking/net_if.rst rename to doc/reference/networking/net_if.rst diff --git a/doc/api/networking/net_l2.rst b/doc/reference/networking/net_l2.rst similarity index 100% rename from doc/api/networking/net_l2.rst rename to doc/reference/networking/net_l2.rst diff --git a/doc/api/networking/net_linkaddr.rst b/doc/reference/networking/net_linkaddr.rst similarity index 100% rename from doc/api/networking/net_linkaddr.rst rename to doc/reference/networking/net_linkaddr.rst diff --git a/doc/api/networking/net_mgmt.rst b/doc/reference/networking/net_mgmt.rst similarity index 100% rename from doc/api/networking/net_mgmt.rst rename to doc/reference/networking/net_mgmt.rst diff --git a/doc/api/networking/net_offload.rst b/doc/reference/networking/net_offload.rst similarity index 100% rename from doc/api/networking/net_offload.rst rename to doc/reference/networking/net_offload.rst diff --git a/doc/api/networking/net_pkt.rst b/doc/reference/networking/net_pkt.rst similarity index 100% rename from doc/api/networking/net_pkt.rst rename to doc/reference/networking/net_pkt.rst diff --git a/doc/api/networking/net_stats.rst b/doc/reference/networking/net_stats.rst similarity index 100% rename from doc/api/networking/net_stats.rst rename to doc/reference/networking/net_stats.rst diff --git a/doc/api/networking/net_tech.rst b/doc/reference/networking/net_tech.rst similarity index 100% rename from doc/api/networking/net_tech.rst rename to doc/reference/networking/net_tech.rst diff --git a/doc/api/networking/net_timeout.rst b/doc/reference/networking/net_timeout.rst similarity index 100% rename from doc/api/networking/net_timeout.rst rename to doc/reference/networking/net_timeout.rst diff --git a/doc/api/networking/promiscuous.rst b/doc/reference/networking/promiscuous.rst similarity index 100% rename from doc/api/networking/promiscuous.rst rename to doc/reference/networking/promiscuous.rst diff --git a/doc/api/networking/protocols.rst b/doc/reference/networking/protocols.rst similarity index 100% rename from doc/api/networking/protocols.rst rename to doc/reference/networking/protocols.rst diff --git a/doc/api/networking/ptp_time.rst b/doc/reference/networking/ptp_time.rst similarity index 100% rename from doc/api/networking/ptp_time.rst rename to doc/reference/networking/ptp_time.rst diff --git a/doc/api/networking/sockets.rst b/doc/reference/networking/sockets.rst similarity index 100% rename from doc/api/networking/sockets.rst rename to doc/reference/networking/sockets.rst diff --git a/doc/api/networking/traffic-class.rst b/doc/reference/networking/traffic-class.rst similarity index 100% rename from doc/api/networking/traffic-class.rst rename to doc/reference/networking/traffic-class.rst diff --git a/doc/api/networking/trickle.rst b/doc/reference/networking/trickle.rst similarity index 100% rename from doc/api/networking/trickle.rst rename to doc/reference/networking/trickle.rst diff --git a/doc/api/networking/udp.rst b/doc/reference/networking/udp.rst similarity index 100% rename from doc/api/networking/udp.rst rename to doc/reference/networking/udp.rst diff --git a/doc/api/networking/vlan.rst b/doc/reference/networking/vlan.rst similarity index 100% rename from doc/api/networking/vlan.rst rename to doc/reference/networking/vlan.rst diff --git a/doc/api/peripherals/adc.rst b/doc/reference/peripherals/adc.rst similarity index 100% rename from doc/api/peripherals/adc.rst rename to doc/reference/peripherals/adc.rst diff --git a/doc/api/peripherals/can.rst b/doc/reference/peripherals/can.rst similarity index 100% rename from doc/api/peripherals/can.rst rename to doc/reference/peripherals/can.rst diff --git a/doc/api/peripherals/counter.rst b/doc/reference/peripherals/counter.rst similarity index 100% rename from doc/api/peripherals/counter.rst rename to doc/reference/peripherals/counter.rst diff --git a/doc/api/peripherals/dma.rst b/doc/reference/peripherals/dma.rst similarity index 100% rename from doc/api/peripherals/dma.rst rename to doc/reference/peripherals/dma.rst diff --git a/doc/api/peripherals/entropy.rst b/doc/reference/peripherals/entropy.rst similarity index 100% rename from doc/api/peripherals/entropy.rst rename to doc/reference/peripherals/entropy.rst diff --git a/doc/api/peripherals/flash.rst b/doc/reference/peripherals/flash.rst similarity index 100% rename from doc/api/peripherals/flash.rst rename to doc/reference/peripherals/flash.rst diff --git a/doc/api/peripherals/gpio.rst b/doc/reference/peripherals/gpio.rst similarity index 100% rename from doc/api/peripherals/gpio.rst rename to doc/reference/peripherals/gpio.rst diff --git a/doc/api/peripherals/i2c.rst b/doc/reference/peripherals/i2c.rst similarity index 100% rename from doc/api/peripherals/i2c.rst rename to doc/reference/peripherals/i2c.rst diff --git a/doc/api/peripherals/i2c_eeprom_slave.rst b/doc/reference/peripherals/i2c_eeprom_slave.rst similarity index 100% rename from doc/api/peripherals/i2c_eeprom_slave.rst rename to doc/reference/peripherals/i2c_eeprom_slave.rst diff --git a/doc/api/peripherals/i2s.rst b/doc/reference/peripherals/i2s.rst similarity index 100% rename from doc/api/peripherals/i2s.rst rename to doc/reference/peripherals/i2s.rst diff --git a/doc/api/peripherals/index.rst b/doc/reference/peripherals/index.rst similarity index 100% rename from doc/api/peripherals/index.rst rename to doc/reference/peripherals/index.rst diff --git a/doc/api/peripherals/ipm.rst b/doc/reference/peripherals/ipm.rst similarity index 100% rename from doc/api/peripherals/ipm.rst rename to doc/reference/peripherals/ipm.rst diff --git a/doc/api/peripherals/pinmux.rst b/doc/reference/peripherals/pinmux.rst similarity index 100% rename from doc/api/peripherals/pinmux.rst rename to doc/reference/peripherals/pinmux.rst diff --git a/doc/api/peripherals/pwm.rst b/doc/reference/peripherals/pwm.rst similarity index 100% rename from doc/api/peripherals/pwm.rst rename to doc/reference/peripherals/pwm.rst diff --git a/doc/api/peripherals/sensor.rst b/doc/reference/peripherals/sensor.rst similarity index 100% rename from doc/api/peripherals/sensor.rst rename to doc/reference/peripherals/sensor.rst diff --git a/doc/api/peripherals/spi.rst b/doc/reference/peripherals/spi.rst similarity index 100% rename from doc/api/peripherals/spi.rst rename to doc/reference/peripherals/spi.rst diff --git a/doc/api/peripherals/uart.rst b/doc/reference/peripherals/uart.rst similarity index 100% rename from doc/api/peripherals/uart.rst rename to doc/reference/peripherals/uart.rst diff --git a/doc/api/peripherals/watchdog.rst b/doc/reference/peripherals/watchdog.rst similarity index 100% rename from doc/api/peripherals/watchdog.rst rename to doc/reference/peripherals/watchdog.rst diff --git a/doc/subsystems/power_management.rst b/doc/reference/power_management/index.rst similarity index 100% rename from doc/subsystems/power_management.rst rename to doc/reference/power_management/index.rst diff --git a/doc/subsystems/shell/images/dynamic_cmd.PNG b/doc/reference/shell/images/dynamic_cmd.PNG similarity index 100% rename from doc/subsystems/shell/images/dynamic_cmd.PNG rename to doc/reference/shell/images/dynamic_cmd.PNG diff --git a/doc/subsystems/shell/images/static_cmd.PNG b/doc/reference/shell/images/static_cmd.PNG similarity index 100% rename from doc/subsystems/shell/images/static_cmd.PNG rename to doc/reference/shell/images/static_cmd.PNG diff --git a/doc/subsystems/shell/images/wildcard.png b/doc/reference/shell/images/wildcard.png similarity index 100% rename from doc/subsystems/shell/images/wildcard.png rename to doc/reference/shell/images/wildcard.png diff --git a/doc/subsystems/shell/shell.rst b/doc/reference/shell/index.rst similarity index 100% rename from doc/subsystems/shell/shell.rst rename to doc/reference/shell/index.rst diff --git a/doc/subsystems/disk/sdhc.rst b/doc/reference/storage/disk/sdhc.rst similarity index 100% rename from doc/subsystems/disk/sdhc.rst rename to doc/reference/storage/disk/sdhc.rst diff --git a/doc/subsystems/storage.rst b/doc/reference/storage/index.rst similarity index 100% rename from doc/subsystems/storage.rst rename to doc/reference/storage/index.rst diff --git a/doc/subsystems/nvs/nvs.rst b/doc/reference/storage/nvs/nvs.rst similarity index 100% rename from doc/subsystems/nvs/nvs.rst rename to doc/reference/storage/nvs/nvs.rst diff --git a/doc/subsystems/settings/settings.rst b/doc/reference/storage/settings/settings.rst similarity index 100% rename from doc/subsystems/settings/settings.rst rename to doc/reference/storage/settings/settings.rst diff --git a/doc/subsystems/usb/usb.rst b/doc/reference/usb/index.rst similarity index 100% rename from doc/subsystems/usb/usb.rst rename to doc/reference/usb/index.rst diff --git a/doc/user_guides.rst b/doc/user_guides.rst deleted file mode 100644 index 8053ac705b..0000000000 --- a/doc/user_guides.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _user_guides: - -User and Developer Guides -######################### - -.. toctree:: - :maxdepth: 1 - - subsystems/bluetooth/index.rst - subsystems/c_library - README.rst - tools/coccinelle.rst - tools/code-relocation.rst - documentation/doc-guidelines.rst - devices/dts/device_tree.rst - subsystems/dfu - tools/kconfig/index.rst - subsystems/mgmt - subsystems/networking/networking.rst - porting/index.rst - subsystems/test/index - subsystems/tracing/index - tools/west/index.rst