Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/binarytree/construct.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:sparkles:| Construct
=========================
============================================

Construct Binary Tree from list.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/dag/construct.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:sparkles:| Construct
=========================
============================================

Construct Directed Acyclic Graph (DAG) from list, dictionary, and pandas DataFrame.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/dag/export.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:hammer:| Export
===================
============================================

Export Directed Acyclic Graph (DAG) to list, dictionary, and pandas DataFrame.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/node/basenode.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:seedling:| BaseNode
=====================
============================================

.. automodule:: bigtree.node.basenode
:members:
Expand Down
4 changes: 2 additions & 2 deletions docs/source/bigtree/node/binarynode.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:herb:| BinaryNode
=====================
|:cherry_blossom:| BinaryNode
============================================

.. automodule:: bigtree.node.binarynode
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/node/dagnode.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:blossom:| DAGNode
=====================
============================================

.. automodule:: bigtree.node.dagnode
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/node/node.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:hibiscus:| Node
=====================
============================================

.. automodule:: bigtree.node.node
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/tree/construct.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:sparkles:| Construct
=========================
============================================

Construct Tree from list, dictionary, and pandas DataFrame.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/tree/export.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:hammer:| Export
===================
============================================

Export Tree to list, dictionary, and pandas DataFrame.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/tree/helper.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:wrench:| Helper
===================
============================================

Helper functions that can come in handy.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/tree/modify.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:memo:| Modify
===================
============================================

There are two types of modification available,

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/tree/search.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:mag:| Search
===================
============================================

Search methods for Trees.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/utils/iterators.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:curly_loop:| Iterators
===========================
============================================

Iterator methods for Trees and DAGs.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/utils/plot.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:bar_chart:| Plot
===========================
============================================

Plotting methods for Trees.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/workflows/app_calendar.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:calendar:| Calendar App
=================================
============================================

.. automodule:: bigtree.workflows.app_calendar
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/bigtree/workflows/app_todo.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:heavy_check_mark:| To Do App
=================================
============================================

.. automodule:: bigtree.workflows.app_todo
:members:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/binarytree.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:cactus:| Binary Tree
===================================
============================================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/dag.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:palm_tree:| Directed Acyclic Graph (DAG)
==========================================
============================================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/demo/binarytree.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/demo/dag.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DAG Demonstration
# 📋 DAG Demonstration

Compared to nodes in tree, nodes in DAG are able to have multiple parents.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/demo/tree.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tree Demonstration
# 📋 Tree Demonstration

Here are some codes to get started.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/demo/workflow.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Demo Usage
# 📋 Workflow Demonstration

There are existing implementations of workflows to showcase how `bigtree` can be used!

Expand Down
2 changes: 1 addition & 1 deletion docs/source/node.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:herb:| Node
===================================
============================================

.. toctree::
:maxdepth: 1
Expand Down
2 changes: 1 addition & 1 deletion docs/source/others.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:globe_with_meridians:| Others
===================================
============================================

.. toctree::
:maxdepth: 3
Expand Down
2 changes: 1 addition & 1 deletion docs/source/tree.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:evergreen_tree:| Tree
===================================
============================================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/utils.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:wrench:| Utils
===================================
============================================

.. toctree::
:maxdepth: 2
Expand Down
2 changes: 1 addition & 1 deletion docs/source/workflows.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
|:construction_worker:| Workflows
===================================
============================================

.. toctree::
:maxdepth: 2
Expand Down