doc updates

Author: amykyta3

docs/best-practices.rst

@@ -7,7 +7,7 @@ Only use the global lexical scope if you want to declare common components that
 you intend to use globally. This avoids polluting the global namespace and
 prevents unexpected component name collisions.
 
-Bad:
+|:thumbsdown:| Bad:
 
 .. code:: systemrdl
 
@@ -24,7 +24,7 @@ Bad:
         my_status_reg status;
     };
 
-Good:
+|:thumbsup:| Good:
 
 .. code:: systemrdl
 

docs/conf.py

@@ -32,6 +32,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
+    'sphinxemoji.sphinxemoji',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/requirements.txt

@@ -1,2 +1,3 @@
 pygments-systemrdl
 sphinx-book-theme
+sphinxemoji

docs/style-guide.rst

@@ -23,7 +23,7 @@ parameter lists, or anything else between braces: ``{``, ``}``, ``(``, ``)``,
 Keep indentation consistent
 ---------------------------
 
-Yes:
+|:thumbsup:| Yes:
 
 .. code:: systemrdl
 
@@ -33,7 +33,7 @@ Yes:
         hw = r;
     } my_field;
 
-No:
+|:thumbsdown:| No:
 
 .. code:: systemrdl
 
@@ -51,7 +51,7 @@ The closing brace ``}`` must be on a line of its own along with its instance
 name if appropriate.
 
 
-Yes:
+|:thumbsup:| Yes:
 
 .. code:: systemrdl
 
@@ -61,7 +61,7 @@ Yes:
         hw = r;
     } my_field;
 
-No:
+|:thumbsdown:| No:
 
 .. code:: systemrdl
 
@@ -75,6 +75,8 @@ No:
 
 If a component has a parameter list, parentheses use the same convention:
 
+|:thumbsup:|
+
 .. code:: systemrdl
 
     field my_field #(
@@ -98,13 +100,13 @@ Where to add spaces
 On both sides of any assignment or expression operators
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Yes:
+|:thumbsup:| Yes:
 
 .. code:: systemrdl
 
     reset = 4 + MY_PARAM / 2;
 
-No:
+|:thumbsdown:| No:
 
 .. code:: systemrdl
 
@@ -113,15 +115,15 @@ No:
 Before and after open/close braces
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Yes:
+|:thumbsup:| Yes:
 
 .. code:: systemrdl
 
     field {
         desc = "My field";
     } my_field;
 
-No:
+|:thumbsdown:| No:
 
 .. code:: systemrdl
 
@@ -139,7 +141,7 @@ In most cases, keep each property assignment on its own distinct line.
 Since properties ``sw`` and ``hw``, are nearly always used together, it is
 acceptable to stack them on the same line.
 
-Yes:
+|:thumbsup:| Yes:
 
 .. code:: systemrdl
 
@@ -151,7 +153,7 @@ Yes:
         onread = rclr;
     } my_field;
 
-No:
+|:thumbsdown:| No:
 
 .. code:: systemrdl
 
@@ -161,7 +163,7 @@ No:
     } my_field;
 
 
-Acceptable:
+|:thumbsup:| Acceptable:
 
 .. code:: systemrdl
 
@@ -177,7 +179,7 @@ Component type and instance names are lowercase
 -----------------------------------------------
 There is no need to yell.
 
-Yes:
+|:thumbsup:| Yes:
 
 .. code:: systemrdl
 
@@ -187,7 +189,7 @@ Yes:
 
     my_field inst;
 
-No:
+|:thumbsdown:| No:
 
 .. code:: systemrdl
 
@@ -211,6 +213,8 @@ Break long descriptions into multiple lines, indented at the same level as the
 scope it is in.
 Start and end quotation marks use the same rules as braces.
 
+|:thumbsup:|
+
 .. code:: systemrdl
 
     field {