[Doc] Added HTML documentation

MH3-46591

.gitignore

@@ -3,6 +3,8 @@
 *.map
 *.d
 *.flag
+*.lock
+Gemfile
 **/nbproject/private
 **/nbproject/Makefile-*
 **/nbproject/Package-*

_config.yml

@@ -0,0 +1,96 @@
+# Welcome to Jekyll!
+#
+# This config file is meant for settings that affect your whole site, values
+# which you are expected to set up once and rarely edit after that. If you find
+# yourself editing these this file very often, consider using Jekyll's data files
+# feature for the data you need to update frequently.
+#
+# For technical reasons, this file is *NOT* reloaded automatically when you use
+# 'jekyll serve'. If you change this file, please restart the server process.
+
+# Site settings
+# These are used to personalize your new site. If you look in the HTML files,
+# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
+# You can create any custom variable you would like, and they will be accessible
+# in the templates via {{ site.myvariable }}.
+
+name: Microchip Technology
+title: Harmony 3 Motor Control Application Examples for SAM RH71 family
+lang: en-US
+timezone: America/Phoenix
+
+description: Harmony 3 Motor Control Applications for SAM RH71 family
+url: "https://microchip-mplab-harmony.github.io"
+baseurl: "/mc_apps_sam_rh71"
+remote_theme: "Microchip-MPLAB-Harmony/just-the-docs@mchp-harmony"
+
+# Build settings
+
+# GH Pages default (to ensure local build is same)
+lsi: false
+safe: true
+incremental: false
+highlighter: rouge
+gist:
+  noscript: false
+kramdown:
+  math_engine: mathjax
+  syntax_highlighter: rouge
+
+markdown: kramdown
+
+plugins:
+  - jekyll-coffeescript                # GH Pages default (to ensure local build is same)
+  - jekyll-default-layout
+  - jekyll-gist
+  - jekyll-github-metadata
+  - jekyll-optional-front-matter
+  - jekyll-paginate
+  - jekyll-readme-index
+  - jekyll-titles-from-headings
+  - jekyll-relative-links
+  - jekyll-seo-tag                     # MCHP
+
+#
+# ------------ Theme configuration ------------
+#
+
+# Enable or disable the site search
+search_enabled: true
+
+# Set the search token separator for hyphenated-word search:
+search_tokenizer_separator: /[\s/]+/
+
+# Enable or disable heading anchors
+heading_anchors: true
+
+# Google Analytics Tracking (optional)
+ga_tracking: UA-2724382-16
+
+exclude:
+  - "*.xml"
+  - "*.py"
+  - "*.ftl"
+  - "*.c"
+  - "*.h"
+  - "*.X"
+  - "*.IAR"
+  - "Gem*"
+  - "*.S"
+  - "*.ld"
+  - "*.jar"
+  - "*.prj"
+
+# Aux links for the upper right navigation
+aux_links:
+#  "See me on GitHub":
+#  "{% octicon mark-github %}":
+#    - "//github.com/Microchip-MPLAB-Harmony/aerospace"
+  "Obtain Support from Microchip":
+    - "https://support.microchip.com"
+
+# Set a path/url to a logo that will be displayed instead of the title
+logo: "/assets/images/vendor/microchip_mplab_harmony_logo_150_transparent.png"
+
+# Footer content appears at the bottom of every page's main content
+footer_content: "<img src='https://raw.githubusercontent.com/wiki/Microchip-MPLAB-Harmony/Microchip-MPLAB-Harmony.github.io/images/microchip_logo.png' /><br />Copyright &copy; 2020 Microchip Technology."

apps/docs/hardware_setup.md

@@ -0,0 +1,18 @@
+---
+title: Hardware Setup
+nav_order: 2
+has_children: true
+has_toc: false
+---
+
+# Hardware Setup
+
+- [SAM RH71 Evaluation Kit](https://ww1.microchip.com/downloads/en/DeviceDoc/SAMRH71F20-EK-Evaluation-Kit-User-Guide-DS50002910A.pdf)
+- [LX7720 Daughter Board](https://www.microsemi.com/product-directory/space-system-managers/3708-position-motor-controller-ic#resources)
+
+| Board | Description |
+| ----------- | --------- |
+| [Setup for Quadrature Encoder Mode](sam_rh71_ek_board_lx7720_dbs.md) | Hardware setup of RH71 Evaluation Kit and LX7720 Daughter Card for quadrature encoder mode |
+|||
+
+

apps/docs/sam_rh71_ek_board_lx7720_db.md

@@ -1,3 +1,10 @@
+---
+parent: Hardware Setup
+title: Setup for quadrature encoder mode
+has_children: false
+has_toc: false
+---
+
 # SAM RH71 Evaluation Kit with LX7720 Daughter Board
 ## Setting up the hardware
 

apps/pmsm_foc_encoder_lx7720_sam_rh71_ek/readme.md

@@ -1,9 +1,8 @@
 ---
-parent: Harmony 3 motor control application examples
-title: Sensored PMSM FOC using SAM RH71 EK and LX7720 DB
+parent: Motor Control Application Examples for SAM RH71 family
+title: Encoder based PMSM FOC using SAM RH71 EK and LX7720 DB
 has_children: false
 has_toc: false
-nav_order: 1
 ---
 
 [![MCHP](https://www.microchip.com/ResourcePackages/Microchip/assets/dist/images/logo.png)](https://www.microchip.com)
@@ -73,9 +72,7 @@ Path of the application within the repository is **apps/pmsm_foc_encoder_lx7720_
 
 To build the application, refer to the following table and open the project using its IDE.
 
-| Project Name      | Description                                    |
-| ----------------- | ---------------------------------------------- |
-| sam_rh71_ek.X | MPLABX project for SAM RH71 Evaluation Kit and LX7720 Daughter Board |
-|||
-
-[Hardware Setup and Running The Application on SAM RH71 Evaluation Kit  with LX7720 Daughter Board](../docs/sam_rh71_ek_board_lx7720_db.md)
+| Project Name      | Description                                    | Demo User Guide |
+| ----------------- | ---------------------------------------------- | ------------------ | 
+| sam_rh71_ek.X | MPLABX project for SAM RH71 Evaluation Kit and LX7720 Daughter Board | [Hardware Setup and Running The Application on SAM RH71 Evaluation Kit  with LX7720 Daughter Board](../docs/sam_rh71_ek_board_lx7720_db.md)
+||||

docs/apps/docs/hardware_setup.html

@@ -0,0 +1 @@
+<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="shortcut icon" href="../../favicon.ico" type="image/x-icon"> <link rel="stylesheet" href="../../assets/css/just-the-docs-default.css"> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-2724382-16"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-2724382-16'); </script> <script type="text/javascript" src="../../assets/js/vendor/lunr.min.js"></script> <script type="text/javascript" src="../../assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.6.1 --> <title>Hardware Setup | Harmony 3 Motor Control Application Examples for SAM RH71 family</title> <meta name="generator" content="Jekyll v3.9.0" /> <meta property="og:title" content="Hardware Setup" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Harmony 3 Motor Control Applications for SAM RH71 family" /> <meta property="og:description" content="Harmony 3 Motor Control Applications for SAM RH71 family" /> <link rel="canonical" href="../../apps/docs/hardware_setup.html" /> <meta property="og:url" content="../../apps/docs/hardware_setup.html" /> <meta property="og:site_name" content="Harmony 3 Motor Control Application Examples for SAM RH71 family" /> <script type="application/ld+json"> {"@type":"WebPage","headline":"Hardware Setup","url":"../../apps/docs/hardware_setup.html","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"../../assets/images/vendor/microchip_mplab_harmony_logo_150_transparent.png"}},"description":"Harmony 3 Motor Control Applications for SAM RH71 family","@context":"https://schema.org"}</script> <!-- End Jekyll SEO tag --> </head> <body> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header"> <a href="../../index.html" class="site-title lh-tight"> <div class="site-logo"></div> </a> <a href="#" id="menu-button" class="site-button"> <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg> </a> </div> <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a><a href="../../index.html" class="nav-list-link">Motor Control Application Examples for SAM RH71 family</a><ul class="nav-list "><li class="nav-list-item "><a href="../../apps/pmsm_foc_encoder_lx7720_sam_rh71_ek/readme.html" class="nav-list-link">Encoder based PMSM FOC using SAM RH71 EK and LX7720 DB</a></li></ul></li><li class="nav-list-item active"><a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a><a href="../../apps/docs/hardware_setup.html" class="nav-list-link active">Hardware Setup</a><ul class="nav-list "><li class="nav-list-item "><a href="../../apps/docs/sam_rh71_ek_board_lx7720_db.html" class="nav-list-link">Setup for quadrature encoder mode</a></li></ul></li><li class="nav-list-item"><a href="../../release_notes.html" class="nav-list-link">Release notes</a></li><li class="nav-list-item"><a href="../../mplab_harmony_license.html" class="nav-list-link">License</a></li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/pmarsceill/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search Harmony 3 Motor Control Application Examples for SAM RH71 family" aria-label="Search Harmony 3 Motor Control Application Examples for SAM RH71 family" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> <nav aria-label="Auxiliary" class="aux-nav"> <ul class="aux-nav-list"> <li class="aux-nav-list-item"> <a href="https://support.microchip.com" class="site-button" > Obtain Support from Microchip </a> </li> </ul> </nav> </div> <div id="main-content-wrap" class="main-content-wrap"> <div id="main-content" class="main-content" role="main"> <h1 id="hardware-setup"> <a href="#hardware-setup" aria-labelledby="hardware-setup" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Hardware Setup </h1> <ul> <li><a href="https://ww1.microchip.com/downloads/en/DeviceDoc/SAMRH71F20-EK-Evaluation-Kit-User-Guide-DS50002910A.pdf">SAM RH71 Evaluation Kit</a></li> <li><a href="https://www.microsemi.com/product-directory/space-system-managers/3708-position-motor-controller-ic#resources">LX7720 Daughter Board</a></li> </ul> <div class="table-wrapper"><table> <thead> <tr> <th>Board</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><a href="sam_rh71_ek_board_lx7720_db.html">Setup for Quadrature Encoder Mode</a></td> <td>Hardware setup of RH71 Evaluation Kit and LX7720 Daughter Card for quadrature encoder mode</td> </tr> <tr> <td> </td> <td> </td> </tr> </tbody> </table></div> <hr> <footer> <p class="text-small text-grey-dk-000 mb-0"><img src='https://raw.githubusercontent.com/wiki/Microchip-MPLAB-Harmony/Microchip-MPLAB-Harmony.github.io/images/microchip_logo.png' /><br />Copyright &copy; 2020 Microchip Technology.</p> <!-- <p class="text-small text-grey-dk-000 mb-0"><img src='../../assets/images/vendor/microchip_logo.png' /><br /> Copyright &copy; 2020 Microchip Technology.</p> --> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>