From 25b8c9f7ae4b7b5ca28b1e831e48c14e22aa2b01 Mon Sep 17 00:00:00 2001
From: ARUL DEVARAJAN <arulkumaran.devarajan@huawei.com>
Date: Fri, 19 Mar 2021 04:32:32 +0000
Subject: [PATCH] Documentation Repo: Sphinx warning fixes issue #36
* Fixed the following issues for sphinx warning:
* about-openharmony and restructuredText Basics topic modified to include figure caption as a single line.
* quickstart/readme topic modified to include :ref syntax for Supported Boards
* quickstart/ Linux and Zephyr flavour topic modified for reference
links in Supported images
* Coding Guidelines removed from Contribution Process.
* Avenger, Nitrogen 96 board and seco-imx8mm: .. _linux-image-1: syntax removed for
duplication
* Supported boards: Readme file modified to 'include ..
_supported-boards:' syntax
*
* Signed off By: Arul Kumaran <arulkumaran.devarajan@huawei.com>
---
overview/about-openharmony.rst | 7 -------
quick-start/README.rst | 2 +-
quick-start/linux-flavour.rst | 7 +++----
quick-start/zephyr-flavour.rst | 4 ++--
readme/Contribution Process.rst | 5 -----
readme/reStructuredText Basics.rst | 7 ++-----
supported-boards/96b-Avenger.rst | 2 --
supported-boards/96b-nitrogen.rst | 2 +-
supported-boards/README.rst | 2 +-
supported-boards/seco-imx8mm-c61.rst | 1 -
10 files changed, 10 insertions(+), 29 deletions(-)
diff --git a/overview/about-openharmony.rst b/overview/about-openharmony.rst
index 2e3da69..c25696b 100644
--- a/overview/about-openharmony.rst
+++ b/overview/about-openharmony.rst
@@ -1,4 +1,3 @@
-
.. include:: ../definitions.rst
About |main_project_name|
@@ -29,12 +28,6 @@ Technical Architecture
**Figure 1 Technical Architecture**
.. figure:: figures/architecture.png
-
- :scale: 50
- :width: 100 px
- :align: center
-
-
Kernel Layer
------------------
diff --git a/quick-start/README.rst b/quick-start/README.rst
index baaf56c..03fa12c 100644
--- a/quick-start/README.rst
+++ b/quick-start/README.rst
@@ -3,7 +3,7 @@
Getting Started Guide
#####################
-|main_project_name| is a distributed OS that is designed to run on top of a variety of OS kernels ranging from Linux to RTOSs. To start with, you can build an |main_project_name| image using your preferred OS flavour using the supported boards. Currently, |main_project_name| supports Linux, Zephyr, and FreeRTOS kernels. The supported boards are listed in :ref:`supported-boards`. The configuration is set with certain default values which can be customized as per your preference.
+|main_project_name| is a distributed OS that is designed to run on top of a variety of OS kernels ranging from Linux to RTOSs. To start with, you can build an |main_project_name| image using your preferred OS flavour using the supported boards. Currently, |main_project_name| supports Linux, Zephyr, and FreeRTOS kernels. The supported boards are listed under :ref:`Supported Boards <supported-boards>`. The configuration is set with certain default values which can be customized as per your preference.
.. toctree::
:maxdepth: 2
diff --git a/quick-start/linux-flavour.rst b/quick-start/linux-flavour.rst
index 70158af..bb587d4 100644
--- a/quick-start/linux-flavour.rst
+++ b/quick-start/linux-flavour.rst
@@ -45,12 +45,11 @@ Supported machines
* - qemuarm64
- Emulator
* - seco-intel-b68 (SECO SBC-B68)
- - `Details <https://www.seco.com/en/products/sbc-b68-enuc>`_
+ - `Details <https://www.seco.com/en/products/sbc-b68-enuc>`__
* - stm32mp1-av96 (96Boards Avenger96)
- - `Details <https://www.96boards.org/product/avenger96/>`_
+ - `Details <https://www.96boards.org/product/avenger96/>`__
* - seco-imx8mm-c61 (SECO SBC-C61)
- - `Details <https://www.seco.com/en/products/sbc-c61>`_
-
+ - `Details <https://www.seco.com/en/products/sbc-c61>`__
Prerequisites
*************
diff --git a/quick-start/zephyr-flavour.rst b/quick-start/zephyr-flavour.rst
index 9d7416c..b578353 100644
--- a/quick-start/zephyr-flavour.rst
+++ b/quick-start/zephyr-flavour.rst
@@ -30,9 +30,9 @@ Supported machines
* - qemu-cortex-m3
- Emulator
* - 96b-nitrogen (96Boards Nitrogen)
- - `Details <https://www.96boards.org/product/nitrogen/>`_
+ - `Details <https://www.96boards.org/product/nitrogen/>`__
* - 96b-avenger96 (96Boards Avenger96)
- - `Details <https://www.96boards.org/product/avenger96/>`_
+ - `Details <https://www.96boards.org/product/avenger96/>`__
Prerequisites
*************
diff --git a/readme/Contribution Process.rst b/readme/Contribution Process.rst
index 5165e26..d93fc5c 100644
--- a/readme/Contribution Process.rst
+++ b/readme/Contribution Process.rst
@@ -62,11 +62,6 @@ Prerequisites
For downloading tools, downloading source code, and building and running |main_project_name| image, see :ref:`Getting Started <BuildOpenharmony>`.
-Coding guidelines
-*****************
-
-Refer to the :ref:`Contributing Code <Contributingcode>` section of the documentation for additional details.
-
Contribution Workflow
*********************
diff --git a/readme/reStructuredText Basics.rst b/readme/reStructuredText Basics.rst
index d9cbef2..54cc041 100644
--- a/readme/reStructuredText Basics.rst
+++ b/readme/reStructuredText Basics.rst
@@ -24,13 +24,10 @@ Sphinx comes with a script called sphinx-quickstart that sets up a source direct
The below quickstart screen appears as shown below:
-.. figure:: images/quick-start.PNG
-
- :align: center
- :alt: Quickstart overview
-
**Figure 1 quickstart utility**
+.. figure:: images/quick-start.PNG
+
For more information on Sphinx Quickstart, refer https://sphinx-rtd-tutorial.readthedocs.io/en/latest/sphinx-quickstart.html.
Defining Document Structure
diff --git a/supported-boards/96b-Avenger.rst b/supported-boards/96b-Avenger.rst
index 01159dc..ec5c827 100644
--- a/supported-boards/96b-Avenger.rst
+++ b/supported-boards/96b-Avenger.rst
@@ -91,8 +91,6 @@ For Zephyr, there is no automation as for now. To have the ELF file in the files
* Include it in the image before flashing the card/eMMC
* Copy the file manually to the card or just *scp* it to the board after you set up networking.
-.. _linux-image-1:
-
Linux image
===========
diff --git a/supported-boards/96b-nitrogen.rst b/supported-boards/96b-nitrogen.rst
index 977fa71..9665198 100644
--- a/supported-boards/96b-nitrogen.rst
+++ b/supported-boards/96b-nitrogen.rst
@@ -42,7 +42,7 @@ Supported image
Building an application
=======================
-|main_project_name|OS Zephyr flavour is based on Zephyr kernel.
+|main_project_name| OS Zephyr flavour is based on Zephyr kernel.
* Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen:
diff --git a/supported-boards/README.rst b/supported-boards/README.rst
index b93ea2c..565ca3f 100644
--- a/supported-boards/README.rst
+++ b/supported-boards/README.rst
@@ -1,4 +1,4 @@
-.. supported-boards:
+.. _supported-boards:
.. include:: ../definitions.rst
diff --git a/supported-boards/seco-imx8mm-c61.rst b/supported-boards/seco-imx8mm-c61.rst
index 4790cbf..4b26c07 100644
--- a/supported-boards/seco-imx8mm-c61.rst
+++ b/supported-boards/seco-imx8mm-c61.rst
@@ -51,7 +51,6 @@ To generate images for eMMC, refer to the following flashing procedure.
Flashing OHOS image
*******************
-.. _linux-image-1:
Linux image
===========
--
GitLab