From 077447a52b4025c5a0d9484f0e87c1b645a9393e Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Thu, 15 Apr 2021 10:15:14 -0400 Subject: [PATCH] doc: consolidate api status and guidelines Move all docs related to APIs and the guidelines around them into one page. Signed-off-by: Anas Nashif --- doc/development_process/index.rst | 1 - doc/guides/index.rst | 1 - .../api}/api_lifecycle.png | Bin .../api}/api_lifecycle.rst | 0 doc/{guides => reference/api}/design_guidelines.rst | 0 doc/reference/api/index.rst | 12 ++++++++++++ doc/reference/{ => api}/overview.rst | 0 doc/reference/{ => api}/terminology.rst | 0 doc/reference/index.rst | 3 +-- 9 files changed, 13 insertions(+), 4 deletions(-) rename doc/{development_process => reference/api}/api_lifecycle.png (100%) rename doc/{development_process => reference/api}/api_lifecycle.rst (100%) rename doc/{guides => reference/api}/design_guidelines.rst (100%) create mode 100644 doc/reference/api/index.rst rename doc/reference/{ => api}/overview.rst (100%) rename doc/reference/{ => api}/terminology.rst (100%) diff --git a/doc/development_process/index.rst b/doc/development_process/index.rst index 66bd1e83352..87594190510 100644 --- a/doc/development_process/index.rst +++ b/doc/development_process/index.rst @@ -12,7 +12,6 @@ Development Model code_flow dev_env_and_tools issues - api_lifecycle communication documentation diff --git a/doc/guides/index.rst b/doc/guides/index.rst index ec72683b8ea..6b1c74c208a 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -12,7 +12,6 @@ User and Developer Guides bluetooth/index.rst build/index coding_guidelines/index - design_guidelines.rst c_library ../README.rst documentation/index diff --git a/doc/development_process/api_lifecycle.png b/doc/reference/api/api_lifecycle.png similarity index 100% rename from doc/development_process/api_lifecycle.png rename to doc/reference/api/api_lifecycle.png diff --git a/doc/development_process/api_lifecycle.rst b/doc/reference/api/api_lifecycle.rst similarity index 100% rename from doc/development_process/api_lifecycle.rst rename to doc/reference/api/api_lifecycle.rst diff --git a/doc/guides/design_guidelines.rst b/doc/reference/api/design_guidelines.rst similarity index 100% rename from doc/guides/design_guidelines.rst rename to doc/reference/api/design_guidelines.rst diff --git a/doc/reference/api/index.rst b/doc/reference/api/index.rst new file mode 100644 index 00000000000..c9de4d947a2 --- /dev/null +++ b/doc/reference/api/index.rst @@ -0,0 +1,12 @@ +.. _api_status_and_guidelines: + +API Status / Guidelines +####################### + +.. toctree:: + :maxdepth: 1 + + overview.rst + api_lifecycle.rst + design_guidelines.rst + terminology.rst diff --git a/doc/reference/overview.rst b/doc/reference/api/overview.rst similarity index 100% rename from doc/reference/overview.rst rename to doc/reference/api/overview.rst diff --git a/doc/reference/terminology.rst b/doc/reference/api/terminology.rst similarity index 100% rename from doc/reference/terminology.rst rename to doc/reference/api/terminology.rst diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 43e73dd9e23..73ec4d55e77 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -6,8 +6,7 @@ API Reference .. toctree:: :maxdepth: 1 - overview.rst - terminology.rst + api/index.rst audio/index.rst misc/notify.rst bluetooth/index.rst