doc: fix sphinx warnning

1. convert markdown to rst. sphinx need extra plugin to parse markdown, so
   the current webpage is not expected
2. update some pictures

Signed-off-by: Jingru Wang <jingru@synopsys.com>

Author: wangnuannuan

doc/documents/arc/arc.rst

@@ -132,7 +132,7 @@ called in entry. You can define your own entry using ``exc_entry_install`` to re
 
 For interrupts, a standard interrupt processing model is shown in the picture below.
 
-.. image:: /pic/interrupt.jpg
+.. image:: /pic/interrupt.png
     :alt: interrupt and exception processing
 
 

doc/documents/board/emsdp.rst

@@ -89,7 +89,7 @@ There are many peripheral devices available, such as SPI, IIC, UART, GPIO.
 Upon these, the |emsdp| offers multiple interfaces for audio, USB, micro-SD card, wireless, ADC, motion sensor, etc.
 External hardware modules can also be easily connected to the board though extension interfaces using Pmod Connectors, Arduino, mikro BUS.
 
-.. image:: /pic/emsdp_peripheral_interfaces.jpg
+.. image:: /pic/emsdp_peripheral_interfaces.png
     :alt: |emsdp| Interfaces
 
 Extensions

doc/documents/board/emsk.rst

@@ -27,7 +27,7 @@ and communication devices. A Digilent Pmod™ compatible extension board
 containing a four-channel 12-bit A/D converter with an IIC interface and an AC
 power adapter are included in the package.
 
-.. image:: /pic/emsk_board.jpg
+.. image:: /pic/emsk_board.png
     :alt: EM Starter Kit Board
 
 
@@ -81,7 +81,7 @@ PMOD pins Definition
 
 The location of the pins on the PMOD connectors is shown:
 
-.. image:: /pic/iotdk_pinout_diagram_of_pmod.jpg
+.. image:: /pic/iotdk_pinout_diagram_of_pmod.png
     :alt: ARC EMSK Pinout Diagram of PMOD
 
 =====  ============  ============       =====  ============  ============

doc/documents/board/hsdk.rst

@@ -16,7 +16,7 @@ Toolkit, MetaWare Lite tools or the ARC GNU Tool Chain.
 See also this URL for details about the board: `DesignWare ARC HS Development Kit
 (HSDK) <https://www.synopsys.com/dw/ipdir.php?ds=arc-hs-development-kit>`_
 
-.. image:: /pic/hsdk_board.jpg
+.. image:: /pic/hsdk_board.png
     :alt: ARC HS Development Kit
 
 
@@ -51,10 +51,10 @@ The ARC HS Development Kit features the following components:
     - mikroBUS headers
     - PMOD Interfaces (3x), PMOD A and PMOD B (12 pins), PMOD C (6 pins)
 
-.. image:: /pic/hsdk_block_diagram.jpg
+.. image:: /pic/hsdk_block_diagram.png
     :alt: ARC HSDK Block Diagram
 
-.. image:: /pic/hsdk_chip.jpg
+.. image:: /pic/hsdk_chip.png
     :alt: ARC HS System on Chip (SoC) Block Diagram
 
 The ARC HS SoC provides the following main features:

doc/documents/board/iotdk.rst

@@ -14,7 +14,7 @@ I/O functions and fast math (trigonometric) accelerator.
 See also this URL for details about the board: `The ARC IoT Development Kit
 (IoTDK) <https://www.synopsys.com/dw/ipdir.php?ds=arc_iot_development_kit>`_
 
-.. image:: /pic/iotdk_board.jpg
+.. image:: /pic/iotdk_board.png
     :alt: DesignWare ARC IoT Development Kit
 
 Components:
@@ -44,10 +44,10 @@ Components:
       - PMOD_C (support GPIO and UART)
     - Extension header (2x 18 pin)
 
-.. image:: /pic/iotdk_block_diagram.jpg
+.. image:: /pic/iotdk_block_diagram.png
     :alt: ARC IoTDK Diagram
 
-.. image:: /pic/iotdk_chip.jpg
+.. image:: /pic/iotdk_chip.png
     :alt: ARC IoTDK Chip Block Diagram
 
 Features:
@@ -92,13 +92,13 @@ The ARC IoT ASIC uses a single 16MHz reference clock from which all the main sys
 The clock generation is centralized in the SYSCONFIG module. The SYSCONFIG module implements a single PLL
 and integer dividers which allows for accurate fine-tuning of the system clocks to the desired frequency.
 
-.. image:: /pic/iotdk_clock_architecture.jpg
+.. image:: /pic/iotdk_clock_architecture.png
     :alt: ARC IoTDK Clock Architecture
 
 Configuration switches
 ----------------------
 
-.. image:: /pic/iotdk_board_switch.jpg
+.. image:: /pic/iotdk_board_switch.png
     :alt: ARC IoTDK switches
 
 The "On" and "Off" position for all four switches are depicted in the figure above, please see details below for function of each switch:
@@ -126,7 +126,7 @@ Extension Interfaces
 
 To bring your application context around the ARC IoTDK, the following peripheral module standards are supported:
 
-.. image:: /pic/iotdk_extension_interfaces.jpg
+.. image:: /pic/iotdk_extension_interfaces.png
     :alt: ARC IoTDK Extension Interfaces
 
 **Digilent PMOD™ (2x)**
@@ -137,7 +137,7 @@ is programmable and includes GPIO and SPI for PMOD_B and GPIO and UART for PMOD_
 After a reset, all ports are configured as GPIO inputs.
 The location of the pins on the PMOD connectors is shown:
 
-.. image:: /pic/iotdk_pinout_diagram_of_pmod.jpg
+.. image:: /pic/iotdk_pinout_diagram_of_pmod.png
     :alt: ARC IoTDK Pinout Diagram of PMOD
 
 =====  ============  ============       =====  ============  ============
@@ -175,7 +175,7 @@ and miscellaneous modules and accessories, See `MikroElektronica <https://www.mi
 get the right function assignment on the MikroBUS headers is controlled by software using the
 ARDUINO_MUX register
 
-.. image:: /pic/iotdk_mikrobus_headers.jpg
+.. image:: /pic/iotdk_mikrobus_headers.png
     :alt: ARC IoTDK MikroBUS Headers
 
 **Arduino (1x)**
@@ -186,7 +186,7 @@ The Arduino shield interface is compatible with the Arduino UNO R3 with the foll
 the IOREF voltage on the ARC IoTDK board is fixed to 3V3. Note that the ICSP header is also not available.
 Most shields do not require this ICSP header as the SPI master interface on this ICSP header is also available on the IO10 to IO13 pins.
 
-.. image:: /pic/iotdk_arduino_shield_interface.jpg
+.. image:: /pic/iotdk_arduino_shield_interface.png
     :alt: ARC IoTDK Arduino Shield Interface
 
 ====== ============ ===================== ============ ============
@@ -219,7 +219,7 @@ IO13   Bit 1	    gpio8b_3[1]	           spi2_clk    gpio8b_3[1]
 **2x18 Pin Extension Header**
 
 
-.. image:: /pic/iotdk_2x18_pin_extension_header.jpg
+.. image:: /pic/iotdk_2x18_pin_extension_header.png
     :alt: ARC IoTDK 2x18 Pin Extension Header
 
 

doc/documents/conf.py

@@ -18,12 +18,11 @@
 #
 import sys
 import os
-import shlex
-# import os
-# import sys
+import sphinx_rtd_theme
 
 sys.path.insert(0, os.path.abspath('..'))
 sys.path.insert(0, os.path.abspath('../../'))
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), 'extensions'))
 
 
 # -- General configuration ------------------------------------------------
@@ -37,9 +36,13 @@
 # ones.
 extensions = ['sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'sphinx.ext.extlinks',
     'sphinx.ext.todo',
     'breathe',
-    'sphinx.ext.ifconfig']
+    'sphinx.ext.ifconfig',
+    'embarc.link-roles',
+    'embarc.html_redirects',
+    'sphinx_tabs.tabs']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -50,8 +53,7 @@
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
+
 source_suffix = ['.rst', '.md']
 
 # The master toctree document.
@@ -87,8 +89,13 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# Additional lexer for Pygments (syntax highlighting)
+from lexer.DtsLexer import DtsLexer
+from sphinx.highlighting import lexers
+lexers['DTS'] = DtsLexer()
+
 # If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = True
+todo_include_todos = False
 
 
 # -- Options for HTML output ----------------------------------------------
@@ -97,7 +104,20 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
-
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme_options = {
+    'prev_next_buttons_location': None
+}
+if tags.has('release'):  # pylint: disable=undefined-variable
+    is_release = True
+    docs_title = 'Docs / %s' %(version)
+else:
+    is_release = False
+    docs_title = 'Docs / Latest'
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = "embARC OSP Project Documentation"
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
@@ -109,6 +129,31 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%b %d, %Y'
+
+# If false, no module index is generated.
+html_domain_indices = False
+
+# If false, no index is generated.
+html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+html_split_index = True
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = False
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+html_show_sphinx = False
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = tags.has('development')
+
+# If true, license is shown in the HTML footer. Default is True.
+html_show_license = True
+
 
 html_context = {
     'css_files': [
@@ -136,7 +181,7 @@
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
+    'preamble': r'\setcounter{tocdepth}{2}',
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',

doc/documents/contribute/CODE_OF_CONDUCT.md renamed to doc/documents/contribute/CODE_OF_CONDUCT.rst

@@ -1,13 +1,19 @@
-# Contributor Covenant Code of Conduct
+.. _code_guidelines:
 
-## Our Pledge
+Contributor Covenant Code of Conduct
+====================================
+
+Our Pledge
+----------
 
 In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+Our Standards
+-------------
 
 Examples of behavior that contributes to creating a positive environment include:
 
+
 * Using welcoming and inclusive language
 * Being respectful of differing viewpoints and experiences
 * Gracefully accepting constructive criticism
@@ -16,32 +22,33 @@ Examples of behavior that contributes to creating a positive environment include
 
 Examples of unacceptable behavior by participants include:
 
+
 * The use of sexualized language or imagery and unwelcome sexual attention or advances
 * Trolling, insulting/derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or electronic address, without explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
-## Our Responsibilities
+Our Responsibilities
+--------------------
 
 Project maintainers may clarify the standards of acceptable behavior and may take appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
 Project maintainers have the right to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
-## Scope
+Scope
+-----
 
 This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
 
-## Enforcement
+Enforcement
+-----------
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at info@embarc.org [mailto:info@embarc.org]. All complaints will be reviewed and project maintainers will have the right to respond in any manner deemed necessary and appropriate to the circumstances. The project team intends to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 
+Attribution
+-----------
 
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [version 1.4][version]
-
-[homepage]: https://www.contributor-covenant.org/
-[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org/>`_\ , version 1.4, available at `version 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`_