Merge pull request #173 from kayjan/enhance-sphinx

kayjan · web-flow · commit 69946de34172 · 2024-01-22T22:20:53.000+08:00
Enhance sphinx
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,8 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- Misc: Sphinx documentation to support mermaid markdown images.
-- Misc: Sphinx documentation to reflect CHANGELOG section.
+- Misc: Sphinx documentation to support mermaid markdown images, reflect CHANGELOG section, add more emojis.
 ### Changed
 - Misc: Update SEO image.
 - Misc: Fix Sphinx documentation font size difference between web and mobile, include last updated date.
diff --git a/docs/source/bigtree/binarytree/construct.rst b/docs/source/bigtree/binarytree/construct.rst
@@ -1,5 +1,5 @@
 |:sparkles:| Construct
-=========================
+============================================
 
 Construct Binary Tree from list.
 
diff --git a/docs/source/bigtree/dag/construct.rst b/docs/source/bigtree/dag/construct.rst
@@ -1,5 +1,5 @@
 |:sparkles:| Construct
-=========================
+============================================
 
 Construct Directed Acyclic Graph (DAG) from list, dictionary, and pandas DataFrame.
 
diff --git a/docs/source/bigtree/dag/export.rst b/docs/source/bigtree/dag/export.rst
@@ -1,5 +1,5 @@
 |:hammer:| Export
-===================
+============================================
 
 Export Directed Acyclic Graph (DAG) to list, dictionary, and pandas DataFrame.
 
diff --git a/docs/source/bigtree/node/basenode.rst b/docs/source/bigtree/node/basenode.rst
@@ -1,5 +1,5 @@
 |:seedling:| BaseNode
-=====================
+============================================
 
 .. automodule:: bigtree.node.basenode
    :members:
diff --git a/docs/source/bigtree/node/binarynode.rst b/docs/source/bigtree/node/binarynode.rst
@@ -1,5 +1,5 @@
-|:herb:| BinaryNode
-=====================
+|:cherry_blossom:| BinaryNode
+============================================
 
 .. automodule:: bigtree.node.binarynode
    :members:
diff --git a/docs/source/bigtree/node/dagnode.rst b/docs/source/bigtree/node/dagnode.rst
@@ -1,5 +1,5 @@
 |:blossom:| DAGNode
-=====================
+============================================
 
 .. automodule:: bigtree.node.dagnode
    :members:
diff --git a/docs/source/bigtree/node/node.rst b/docs/source/bigtree/node/node.rst
@@ -1,5 +1,5 @@
 |:hibiscus:| Node
-=====================
+============================================
 
 .. automodule:: bigtree.node.node
    :members:
diff --git a/docs/source/bigtree/tree/construct.rst b/docs/source/bigtree/tree/construct.rst
@@ -1,5 +1,5 @@
 |:sparkles:| Construct
-=========================
+============================================
 
 Construct Tree from list, dictionary, and pandas DataFrame.
 
diff --git a/docs/source/bigtree/tree/export.rst b/docs/source/bigtree/tree/export.rst
@@ -1,5 +1,5 @@
 |:hammer:| Export
-===================
+============================================
 
 Export Tree to list, dictionary, and pandas DataFrame.
 
diff --git a/docs/source/bigtree/tree/helper.rst b/docs/source/bigtree/tree/helper.rst
@@ -1,5 +1,5 @@
 |:wrench:| Helper
-===================
+============================================
 
 Helper functions that can come in handy.
 
diff --git a/docs/source/bigtree/tree/modify.rst b/docs/source/bigtree/tree/modify.rst
@@ -1,5 +1,5 @@
 |:memo:| Modify
-===================
+============================================
 
 There are two types of modification available,
 
diff --git a/docs/source/bigtree/tree/search.rst b/docs/source/bigtree/tree/search.rst
@@ -1,5 +1,5 @@
 |:mag:| Search
-===================
+============================================
 
 Search methods for Trees.
 
diff --git a/docs/source/bigtree/utils/iterators.rst b/docs/source/bigtree/utils/iterators.rst
@@ -1,5 +1,5 @@
 |:curly_loop:| Iterators
-===========================
+============================================
 
 Iterator methods for Trees and DAGs.
 
diff --git a/docs/source/bigtree/utils/plot.rst b/docs/source/bigtree/utils/plot.rst
@@ -1,5 +1,5 @@
 |:bar_chart:| Plot
-===========================
+============================================
 
 Plotting methods for Trees.
 
diff --git a/docs/source/bigtree/workflows/app_calendar.rst b/docs/source/bigtree/workflows/app_calendar.rst
@@ -1,5 +1,5 @@
 |:calendar:| Calendar App
-=================================
+============================================
 
 .. automodule:: bigtree.workflows.app_calendar
    :members:
diff --git a/docs/source/bigtree/workflows/app_todo.rst b/docs/source/bigtree/workflows/app_todo.rst
@@ -1,5 +1,5 @@
 |:heavy_check_mark:| To Do App
-=================================
+============================================
 
 .. automodule:: bigtree.workflows.app_todo
    :members:
diff --git a/docs/source/binarytree.rst b/docs/source/binarytree.rst
@@ -1,5 +1,5 @@
 |:cactus:| Binary Tree
-===================================
+============================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/dag.rst b/docs/source/dag.rst
@@ -1,5 +1,5 @@
 |:palm_tree:| Directed Acyclic Graph (DAG)
-==========================================
+============================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/demo/binarytree.md b/docs/source/demo/binarytree.md
@@ -1,4 +1,4 @@
-# Binary Tree Demonstration
+# 📋 Binary Tree Demonstration
 
 Compared to nodes in tree, nodes in Binary Tree are only allowed maximum of 2 children.
 Since BinaryNode extends from Node, construct, traverse, search, export methods from Node are applicable to
diff --git a/docs/source/demo/dag.md b/docs/source/demo/dag.md
@@ -1,4 +1,4 @@
-# DAG Demonstration
+# 📋 DAG Demonstration
 
 Compared to nodes in tree, nodes in DAG are able to have multiple parents.
 
diff --git a/docs/source/demo/tree.md b/docs/source/demo/tree.md
@@ -1,4 +1,4 @@
-# Tree Demonstration
+# 📋 Tree Demonstration
 
 Here are some codes to get started.
 
diff --git a/docs/source/demo/workflow.md b/docs/source/demo/workflow.md
@@ -1,4 +1,4 @@
-# Demo Usage
+# 📋 Workflow Demonstration
 
 There are existing implementations of workflows to showcase how `bigtree` can be used!
 
diff --git a/docs/source/node.rst b/docs/source/node.rst
@@ -1,5 +1,5 @@
 |:herb:| Node
-===================================
+============================================
 
 .. toctree::
    :maxdepth: 1
diff --git a/docs/source/others.rst b/docs/source/others.rst
@@ -1,5 +1,5 @@
 |:globe_with_meridians:| Others
-===================================
+============================================
 
 .. toctree::
    :maxdepth: 3
diff --git a/docs/source/tree.rst b/docs/source/tree.rst
@@ -1,5 +1,5 @@
 |:evergreen_tree:| Tree
-===================================
+============================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/utils.rst b/docs/source/utils.rst
@@ -1,5 +1,5 @@
 |:wrench:| Utils
-===================================
+============================================
 
 .. toctree::
    :maxdepth: 2
diff --git a/docs/source/workflows.rst b/docs/source/workflows.rst
@@ -1,5 +1,5 @@
 |:construction_worker:| Workflows
-===================================
+============================================
 
 .. toctree::
    :maxdepth: 2
