Merge pull request #140 from kayjan/enhance-docstr

Enhance docstr

Author: kayjan

.gitignore

@@ -3,8 +3,7 @@
 *pytest_cache/
 *__pycache__*
 
-tests/*png
-tests/*dot
 dist/
 */build/
 *.DS_Store
+assets/docstr

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.14.8] - 2023-12-25
+### Changed
+- Tree Modifier: Enhance documentation examples.
+- Workflow To Do App: Change import and export logic.
+- Misc: Organize assets folder based on whether it originated from README, docstrings, or sphinx documentation.
+- Misc: Rename functions in `plot.py` utils file for coverage report.
+### Fixed
+- Misc: Fixed doctests and automate doctest checks.
+
 ## [0.14.7] - 2023-12-22
 ### Changed
 - Tree Helper: `get_tree_diff` enhanced to compare tree attributes by taking in `attr_list` parameter, and indicates difference with `(~)`.

README.md

@@ -183,10 +183,10 @@ root.show()
 # └── c
 
 graph = tree_to_dot(root, node_colour="gold")
-graph.write_png("assets/demo_tree.png")
+graph.write_png("assets/docs/demo_tree.png")
 ```
 
-![Sample Tree Output](https://github.com/kayjan/bigtree/raw/master/assets/demo_tree.png)
+![Sample Tree Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_tree.png)
 
 {emphasize-lines="8-10"}
 ```python
@@ -897,22 +897,22 @@ tree_to_dataframe(
 # 4    /a/c    c      a          60
 
 graph = tree_to_dot(root, node_colour="gold")
-graph.write_png("assets/demo.png")
+graph.write_png("assets/docs/demo_dot.png")
 
 pillow_image = tree_to_pillow(root)
-pillow_image.save("assets/demo_pillow.png")
+pillow_image.save("assets/docs/demo_pillow.png")
 
 mermaid_md = tree_to_mermaid(root)
 print(mermaid_md)
 ```
 
-- demo.png
+- demo_dot.png
 
-![Sample Dot Image Output](https://github.com/kayjan/bigtree/raw/master/assets/demo.png)
+![Sample Dot Image Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_dot.png)
 
 - demo_pillow.png
 
-![Sample Pillow Image Output](https://github.com/kayjan/bigtree/raw/master/assets/demo_pillow.png)
+![Sample Pillow Image Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_pillow.png)
 
 - Mermaid flowchart
 ```mermaid
@@ -954,10 +954,10 @@ g = BinaryNode(7, parent=c)
 h = BinaryNode(8, parent=d)
 
 graph = tree_to_dot(a, node_colour="gold")
-graph.write_png("assets/demo_binarytree.png")
+graph.write_png("assets/docs/demo_binarytree.png")
 ```
 
-![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/demo_binarytree.png)
+![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_binarytree.png)
 
 2. **From *list***
 
@@ -1058,10 +1058,10 @@ h = DAGNode("h")
 g = DAGNode("g", parents=[c], children=[h])
 
 graph = dag_to_dot(a, node_colour="gold")
-graph.write_png("assets/demo_dag.png")
+graph.write_png("assets/docs/demo_dag.png")
 ```
 
-![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/demo_dag.png)
+![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_dag.png)
 
 2. **From *list***