Skip to content
Snippets Groups Projects
Commit 5a4c3d12 authored by Gururaj Shetty's avatar Gururaj Shetty
Browse files

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: default avatarGururaj Shetty <gururaj.shetty@huawei.com>
parent a7f3b76c
No related branches found
No related tags found
No related merge requests found
...@@ -48,7 +48,8 @@ language = 'en' ...@@ -48,7 +48,8 @@ language = 'en'
# List of patterns, relative to source directory, that match files and # List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files. # directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path. # 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 ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
......
...@@ -35,16 +35,72 @@ will be flexible enough to target a wide range of devices that accompany users' ...@@ -35,16 +35,72 @@ will be flexible enough to target a wide range of devices that accompany users'
daily life. daily life.
.. toctree:: .. 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 :maxdepth: 2
overview/index
oniro/index
Oniro Project Blueprints <https://docs.oniroproject.org/projects/blueprints> 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 contributing/index
ci/index ci/index
building-project-documentation
ip-policy/index .. toctree::
security/index :caption: Community
:maxdepth: 2
code-of-conduct code-of-conduct
community-chat-platform community-chat-platform
.. toctree::
:caption: Policies and Compliance
:maxdepth: 2
ip-policy/index
security/index
.. toctree::
:caption: Releases
:maxdepth: 2
releases/index releases/index
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
|main_project_name| Overview
###############################
.. toctree::
:maxdepth: 2
oniroproject-vision
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment