From 53d8d0183ae906bb727257ef5ec6ebb5790cc8e5 Mon Sep 17 00:00:00 2001
From: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>
Date: Thu, 8 Sep 2022 10:40:51 +0000
Subject: [PATCH] docs: restore archived boards
Archived boards are no longer supported but are cross-referenced from
the docs.git repository, and therefore must be present in the index to
link correctly.
Signed-off-by: Zygmunt Krynicki <zygmunt.krynicki@huawei.com>
---
docs/conf.py | 2 +-
.../boards/archive/96b-nitrogen.rst | 2 +-
.../hardware-support/boards/archive/index.rst | 19 +++++++++++++++++++
.../boards/archive/nRF52840-DK.rst | 2 +-
docs/hardware-support/index.rst | 1 +
5 files changed, 23 insertions(+), 3 deletions(-)
create mode 100644 docs/hardware-support/boards/archive/index.rst
diff --git a/docs/conf.py b/docs/conf.py
index b90c284f..33ad467c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -48,7 +48,7 @@ language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['hardware-support/boards/archive/*']
+exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
diff --git a/docs/hardware-support/boards/archive/96b-nitrogen.rst b/docs/hardware-support/boards/archive/96b-nitrogen.rst
index 6a7794ee..ef20233a 100644
--- a/docs/hardware-support/boards/archive/96b-nitrogen.rst
+++ b/docs/hardware-support/boards/archive/96b-nitrogen.rst
@@ -2,7 +2,7 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-.. include:: ../../definitions.rst
+.. include:: ../../../definitions.rst
.. _SupportedBoardNitrogen:
diff --git a/docs/hardware-support/boards/archive/index.rst b/docs/hardware-support/boards/archive/index.rst
new file mode 100644
index 00000000..0baa9d81
--- /dev/null
+++ b/docs/hardware-support/boards/archive/index.rst
@@ -0,0 +1,19 @@
+.. SPDX-FileCopyrightText: Huawei Inc.
+..
+.. SPDX-License-Identifier: CC-BY-4.0
+
+.. include:: ../../../definitions.rst
+
+.. _ArchivedBoards:
+
+Archived Boards
+###############
+
+This sectoin details boards that have been archived. They may have been used in
+a past release and are retained here for reference.
+
+.. toctree::
+ :maxdepth: 1
+
+ 96b-nitrogen
+ nRF52840-DK
diff --git a/docs/hardware-support/boards/archive/nRF52840-DK.rst b/docs/hardware-support/boards/archive/nRF52840-DK.rst
index 25a622fa..08536d6d 100644
--- a/docs/hardware-support/boards/archive/nRF52840-DK.rst
+++ b/docs/hardware-support/boards/archive/nRF52840-DK.rst
@@ -2,7 +2,7 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
-.. include:: ../../definitions.rst
+.. include:: ../../../definitions.rst
.. _SupportedBoardnRF52840DK:
diff --git a/docs/hardware-support/index.rst b/docs/hardware-support/index.rst
index 781e2f31..cae88224 100644
--- a/docs/hardware-support/index.rst
+++ b/docs/hardware-support/index.rst
@@ -16,6 +16,7 @@ This section details the hardware (including virtualized) supported as part of
:maxdepth: 2
boards/index
+ boards/archive/index
virtual-boards/index
adding-hardware-support
peripherals/index
--
GitLab