From 5a4c3d12be1f1ae40b5e444d5beb98042a052a56 Mon Sep 17 00:00:00 2001
From: Gururaj Shetty <gururaj.shetty@huawei.com>
Date: Fri, 12 Nov 2021 21:15:06 +0530
Subject: [PATCH] Restructure Doc TOC
* Restructure main page
* Exclude Index files which are not used
* Rework on the documentation flow
* Related/Dependent on https://booting.oniroproject.org/distro/oniro/-/merge_requests/457
* Closes: https://git.ostc-eu.org/distro/docs/-/issues/80
Signed-off-by: Gururaj Shetty <gururaj.shetty@huawei.com>
---
conf.py | 3 ++-
index.rst | 66 ++++++++++++++++++++++++++++++++++++++++++----
overview/index.rst | 13 ---------
3 files changed, 63 insertions(+), 19 deletions(-)
delete mode 100644 overview/index.rst
diff --git a/conf.py b/conf.py
index 6aa5e78..ae5d978 100644
--- a/conf.py
+++ b/conf.py
@@ -48,7 +48,8 @@ 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 = ['README.rst', 'contributing/project.rst', 'experimental']
+exclude_patterns = ['README.rst', 'contributing/project.rst', 'experimental',
+ 'oniro/index.rst']
# -- Options for HTML output -------------------------------------------------
diff --git a/index.rst b/index.rst
index eaa6282..6af2a20 100644
--- a/index.rst
+++ b/index.rst
@@ -35,16 +35,72 @@ will be flexible enough to target a wide range of devices that accompany users'
daily life.
.. toctree::
+ :caption: Introduction
+ :maxdepth: 2
+
+ overview/oniroproject-vision
+
+.. toctree::
+ :caption: Quick Start
+ :maxdepth: 2
+
+ oniro/oniro-quick-build
+
+.. toctree::
+ :caption: Oniro Project Blueprints
:maxdepth: 2
- overview/index
- oniro/index
Oniro Project Blueprints <https://docs.oniroproject.org/projects/blueprints>
+
+.. toctree::
+ :caption: Build System Guide
+ :maxdepth: 2
+
+ Overview <oniro/yocto-build-system/index>
+ Creating Workspace <oniro/repo-workspace>
+ oniro/build-flavours/index
+ oniro/oniro-build/index
+ oniro/os/index
+ oniro/ci/index
+ oniro/supported-images
+ oniro/hardware-support/index
+ building-project-documentation
+
+.. toctree::
+ :caption: Supported Technologies
+ :maxdepth: 2
+
+ oniro/supported-technologies/openthread
+
+.. toctree::
+ :caption: Troubleshoot
+ :maxdepth: 2
+
+ oniro/fallback-devices-support
+
+.. toctree::
+ :caption: Contribute
+ :maxdepth: 2
+
contributing/index
ci/index
- building-project-documentation
- ip-policy/index
- security/index
+
+.. toctree::
+ :caption: Community
+ :maxdepth: 2
+
code-of-conduct
community-chat-platform
+
+.. toctree::
+ :caption: Policies and Compliance
+ :maxdepth: 2
+
+ ip-policy/index
+ security/index
+
+.. toctree::
+ :caption: Releases
+ :maxdepth: 2
+
releases/index
diff --git a/overview/index.rst b/overview/index.rst
deleted file mode 100644
index efe09c5..0000000
--- a/overview/index.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-.. SPDX-FileCopyrightText: Huawei Inc.
-..
-.. SPDX-License-Identifier: CC-BY-4.0
-
-.. include:: ../definitions.rst
-
-|main_project_name| Overview
-###############################
-
-.. toctree::
- :maxdepth: 2
-
- oniroproject-vision
--
GitLab