Merge pull request #124 from kayjan/highlight-text

kayjan · web-flow · commit e2729f000227 · 2023-11-24T03:39:28.000+08:00
Documentation enhancement to highlight code blocks
diff --git a/README.md b/README.md
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,5 @@
-autodocsumm==0.2.9
+autodocsumm==0.2.11
 karma-sphinx-theme==0.0.8
-myst-parser==0.18.1
+myst-parser~=1.0.0
 pandas==1.5.1
 sphinxemoji==0.2.0
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -1,7 +1,7 @@
 /* Palette
  #1D4289 Blue
  #212322 Black
- #D7A068 Gold (Replace #CEB47E Sand)
+ #D7A068 Gold (rgb 215,160,104)(Replace #CEB47E Sand)
  #DBE2E9 Light blue
  #B7926C Dark sand
 */
@@ -21,11 +21,15 @@ header {
 h1, h2, h3, h4, p, a {
     font-family: Nobile, sans-serif !important;
 }
+p {
+    margin-bottom: 2rem;
+}
 a {
     color: #D7A068 !important;
 }
 blockquote {
-    border-left: 5px solid grey;
+    border-left: 2px solid grey;
+    padding: 0.5rem 1.5rem;
 }
 blockquote p {
     display: inline;
@@ -55,11 +59,15 @@ span.pre {
 
 /* Code box */
 .highlight pre {
-    background: lightyellow !important;
+    background: lightyellow;
 }
 .highlight .c1 {
     font-style: normal;
 }
+.hll {
+    display: block;
+    background-color: rgba(215,160,104,0.2) !important;
+}
 
 /* Table */
 table {
diff --git a/docs/source/binarytree.rst b/docs/source/binarytree.rst
@@ -1,4 +1,4 @@
-Binary Tree
+|:cactus:| Binary Tree
 ===================================
 
 .. toctree::
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -31,6 +31,9 @@
 ]
 autodoc_default_options = {"autosummary": True}
 sphinxemoji_style = "twemoji"
+myst_enable_extensions = [
+    "attrs_block",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = []
diff --git a/docs/source/dag.rst b/docs/source/dag.rst
@@ -1,5 +1,5 @@
-Directed Acyclic Graph (DAG)
-===================================
+|:palm_tree:| Directed Acyclic Graph (DAG)
+==========================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -28,7 +28,7 @@
    :alt: black
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
 
    node
    binarytree
diff --git a/docs/source/node.rst b/docs/source/node.rst
@@ -1,4 +1,4 @@
-Node
+|:herb:| Node
 ===================================
 
 .. toctree::
diff --git a/docs/source/others.rst b/docs/source/others.rst
@@ -1,4 +1,4 @@
-Others
+|:globe_with_meridians:| Others
 ===================================
 
 .. toctree::
diff --git a/docs/source/tree.rst b/docs/source/tree.rst
@@ -1,4 +1,4 @@
-Tree
+|:evergreen_tree:| Tree
 ===================================
 
 .. toctree::
diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -1,4 +1,4 @@
-Utils
+|:wrench:| Utils
 ===================================
 
 .. toctree::
diff --git a/docs/source/workflows.rst b/docs/source/workflows.rst
@@ -1,4 +1,4 @@
-Workflows
+|:construction_worker:| Workflows
 ===================================
 
 .. toctree::

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Binary Tree`
	`1`	`+\|:cactus:\| Binary Tree`
`2`	`2`	`===================================`
`3`	`3`
`4`	`4`	`.. toctree::`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,9 @@`
`31`	`31`	`]`
`32`	`32`	`autodoc_default_options = {"autosummary": True}`
`33`	`33`	`sphinxemoji_style = "twemoji"`
	`34`	`+myst_enable_extensions = [`
	`35`	`+ "attrs_block",`
	`36`	`+]`
`34`	`37`
`35`	`38`	`templates_path = ["_templates"]`
`36`	`39`	`exclude_patterns = []`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Node`
	`1`	`+\|:herb:\| Node`
`2`	`2`	`===================================`
`3`	`3`
`4`	`4`	`.. toctree::`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Others`
	`1`	`+\|:globe_with_meridians:\| Others`
`2`	`2`	`===================================`
`3`	`3`
`4`	`4`	`.. toctree::`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Tree`
	`1`	`+\|:evergreen_tree:\| Tree`
`2`	`2`	`===================================`
`3`	`3`
`4`	`4`	`.. toctree::`