Skip to content
Snippets Groups Projects
Commit 25b8c9f7 authored by ARUL DEVARAJAN's avatar ARUL DEVARAJAN Committed by Arul Kumaran
Browse files

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>
parent 998d81a6
No related branches found
No related tags found
No related merge requests found
.. include:: ../definitions.rst .. include:: ../definitions.rst
About |main_project_name| About |main_project_name|
...@@ -29,12 +28,6 @@ Technical Architecture ...@@ -29,12 +28,6 @@ Technical Architecture
**Figure 1 Technical Architecture** **Figure 1 Technical Architecture**
.. figure:: figures/architecture.png .. figure:: figures/architecture.png
:scale: 50
:width: 100 px
:align: center
Kernel Layer Kernel Layer
------------------ ------------------
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
Getting Started Guide 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:: .. toctree::
:maxdepth: 2 :maxdepth: 2
......
...@@ -45,12 +45,11 @@ Supported machines ...@@ -45,12 +45,11 @@ Supported machines
* - qemuarm64 * - qemuarm64
- Emulator - Emulator
* - seco-intel-b68 (SECO SBC-B68) * - 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) * - stm32mp1-av96 (96Boards Avenger96)
- `Details <https://www.96boards.org/product/avenger96/>`_ - `Details <https://www.96boards.org/product/avenger96/>`__
* - seco-imx8mm-c61 (SECO SBC-C61) * - 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 Prerequisites
************* *************
......
...@@ -30,9 +30,9 @@ Supported machines ...@@ -30,9 +30,9 @@ Supported machines
* - qemu-cortex-m3 * - qemu-cortex-m3
- Emulator - Emulator
* - 96b-nitrogen (96Boards Nitrogen) * - 96b-nitrogen (96Boards Nitrogen)
- `Details <https://www.96boards.org/product/nitrogen/>`_ - `Details <https://www.96boards.org/product/nitrogen/>`__
* - 96b-avenger96 (96Boards Avenger96) * - 96b-avenger96 (96Boards Avenger96)
- `Details <https://www.96boards.org/product/avenger96/>`_ - `Details <https://www.96boards.org/product/avenger96/>`__
Prerequisites Prerequisites
************* *************
......
...@@ -62,11 +62,6 @@ Prerequisites ...@@ -62,11 +62,6 @@ Prerequisites
For downloading tools, downloading source code, and building and running |main_project_name| image, see :ref:`Getting Started <BuildOpenharmony>`. 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 Contribution Workflow
********************* *********************
......
...@@ -24,13 +24,10 @@ Sphinx comes with a script called sphinx-quickstart that sets up a source direct ...@@ -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: The below quickstart screen appears as shown below:
.. figure:: images/quick-start.PNG
:align: center
:alt: Quickstart overview
**Figure 1 quickstart utility** **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. For more information on Sphinx Quickstart, refer https://sphinx-rtd-tutorial.readthedocs.io/en/latest/sphinx-quickstart.html.
Defining Document Structure Defining Document Structure
......
...@@ -91,8 +91,6 @@ For Zephyr, there is no automation as for now. To have the ELF file in the files ...@@ -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 * 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. * Copy the file manually to the card or just *scp* it to the board after you set up networking.
.. _linux-image-1:
Linux image Linux image
=========== ===========
......
...@@ -42,7 +42,7 @@ Supported image ...@@ -42,7 +42,7 @@ Supported image
Building an application 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: * Source the environment with proper template settings, flavour being zephyr and target machine being 96b-nitrogen:
......
.. supported-boards: .. _supported-boards:
.. include:: ../definitions.rst .. include:: ../definitions.rst
......
...@@ -51,7 +51,6 @@ To generate images for eMMC, refer to the following flashing procedure. ...@@ -51,7 +51,6 @@ To generate images for eMMC, refer to the following flashing procedure.
Flashing OHOS image Flashing OHOS image
******************* *******************
.. _linux-image-1:
Linux image Linux image
=========== ===========
......
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