kayjan · kayjan · Jan 24, 2024 · Jan 24, 2024
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -29,14 +29,14 @@ jobs:
         uses: actions/setup-python@v4
       - name: Install dependencies
         run: |
-          pip install -r docs/requirements.txt
+          pip install -r docs_sphinx/requirements.txt
       - name: Sphinx build
         run: |
-          sphinx-build docs/source docs/build
+          sphinx-build docs_sphinx/source docs_sphinx/build
       - name: Deploy to GH Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/build/
+          publish_dir: docs_sphinx/build/
           force_orphan: true
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,4 +29,4 @@ repos:
     rev: v0.902
     hooks:
       - id: mypy
-        exclude: "tests/|docs/"
+        exclude: "tests/|docs/|docs_sphinx/"
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -13,9 +13,9 @@ build:
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
-   configuration: docs/source/conf.py
+   configuration: docs_sphinx/source/conf.py
 
 # Optionally declare the Python requirements required to build your docs
 python:
   install:
-    - requirements: docs/requirements.txt
+    - requirements: docs_sphinx/requirements.txt
diff --git a/assets/docs/demo_binarytree.png → assets/demo/binarytree.png b/assets/docs/demo_binarytree.png → assets/demo/binarytree.png
diff --git a/assets/docs/demo_dag.png → assets/demo/dag.png b/assets/docs/demo_dag.png → assets/demo/dag.png
diff --git a/assets/docs/demo_dot.png → assets/demo/dot.png b/assets/docs/demo_dot.png → assets/demo/dot.png
diff --git a/assets/docs/demo_pillow.png → assets/demo/pillow.png b/assets/docs/demo_pillow.png → assets/demo/pillow.png
diff --git a/assets/docs/demo_tree.png → assets/demo/tree.png b/assets/docs/demo_tree.png → assets/demo/tree.png
diff --git a/assets/sphinx/dag_construct.png → assets/docs/dag_construct.png b/assets/sphinx/dag_construct.png → assets/docs/dag_construct.png
diff --git a/assets/sphinx/modify_advanced.png → assets/docs/modify_advanced.png b/assets/sphinx/modify_advanced.png → assets/docs/modify_advanced.png
diff --git a/assets/sphinx/modify_shift_and_copy.png → assets/docs/modify_shift_and_copy.png b/assets/sphinx/modify_shift_and_copy.png → assets/docs/modify_shift_and_copy.png
diff --git a/assets/sphinx/tree_construct.png → assets/docs/tree_construct.png b/assets/sphinx/tree_construct.png → assets/docs/tree_construct.png
diff --git a/assets/sphinx/weighted_tree.png → assets/docs/weighted_tree.png b/assets/sphinx/weighted_tree.png → assets/docs/weighted_tree.png
diff --git a/docs/Makefile → docs_sphinx/Makefile b/docs/Makefile → docs_sphinx/Makefile
diff --git a/docs/make.bat → docs_sphinx/make.bat b/docs/make.bat → docs_sphinx/make.bat
diff --git a/docs/requirements.txt → docs_sphinx/requirements.txt b/docs/requirements.txt → docs_sphinx/requirements.txt
diff --git a/docs/source/_static/custom.css → docs_sphinx/source/_static/custom.css b/docs/source/_static/custom.css → docs_sphinx/source/_static/custom.css
diff --git a/docs/source/_static/favicon.ico → docs_sphinx/source/_static/favicon.ico b/docs/source/_static/favicon.ico → docs_sphinx/source/_static/favicon.ico
diff --git a/docs/source/_templates/layout.html → docs_sphinx/source/_templates/layout.html b/docs/source/_templates/layout.html → docs_sphinx/source/_templates/layout.html
diff --git a/docs/source/bigtree/binarytree/construct.rst → ...x/source/bigtree/binarytree/construct.rst b/docs/source/bigtree/binarytree/construct.rst → ...x/source/bigtree/binarytree/construct.rst
diff --git a/docs/source/bigtree/dag/construct.rst → docs_sphinx/source/bigtree/dag/construct.rst b/docs/source/bigtree/dag/construct.rst → docs_sphinx/source/bigtree/dag/construct.rst
@@ -23,8 +23,8 @@ Construct Directed Acyclic Graph (DAG) from list, dictionary, and pandas DataFra
 These functions are not standalone functions.
 Under the hood, they have the following dependency,
 
-.. image:: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/dag_construct.png
-   :target: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/dag_construct.png
+.. image:: https://github.com/kayjan/bigtree/raw/master/assets/docs/dag_construct.png
+   :target: https://github.com/kayjan/bigtree/raw/master/assets/docs/dag_construct.png
    :alt: DAG Constructor Dependency Diagram
 
 .. automodule:: bigtree.dag.construct

diff --git a/docs/source/bigtree/dag/export.rst → docs_sphinx/source/bigtree/dag/export.rst b/docs/source/bigtree/dag/export.rst → docs_sphinx/source/bigtree/dag/export.rst
diff --git a/docs/source/bigtree/node/basenode.rst → docs_sphinx/source/bigtree/node/basenode.rst b/docs/source/bigtree/node/basenode.rst → docs_sphinx/source/bigtree/node/basenode.rst
diff --git a/docs/source/bigtree/node/binarynode.rst → ...sphinx/source/bigtree/node/binarynode.rst b/docs/source/bigtree/node/binarynode.rst → ...sphinx/source/bigtree/node/binarynode.rst
diff --git a/docs/source/bigtree/node/dagnode.rst → docs_sphinx/source/bigtree/node/dagnode.rst b/docs/source/bigtree/node/dagnode.rst → docs_sphinx/source/bigtree/node/dagnode.rst
diff --git a/docs/source/bigtree/node/node.rst → docs_sphinx/source/bigtree/node/node.rst b/docs/source/bigtree/node/node.rst → docs_sphinx/source/bigtree/node/node.rst
diff --git a/docs/source/bigtree/tree/construct.rst → ..._sphinx/source/bigtree/tree/construct.rst b/docs/source/bigtree/tree/construct.rst → ..._sphinx/source/bigtree/tree/construct.rst
@@ -63,8 +63,8 @@ To add attributes to existing tree,
 These functions are not standalone functions.
 Under the hood, they have the following dependency,
 
-.. image:: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/tree_construct.png
-   :target: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/tree_construct.png
+.. image:: https://github.com/kayjan/bigtree/raw/master/assets/docs/tree_construct.png
+   :target: https://github.com/kayjan/bigtree/raw/master/assets/docs/tree_construct.png
    :alt: Tree Constructor Dependency Diagram
 
 .. automodule:: bigtree.tree.construct

diff --git a/docs/source/bigtree/tree/export.rst → docs_sphinx/source/bigtree/tree/export.rst b/docs/source/bigtree/tree/export.rst → docs_sphinx/source/bigtree/tree/export.rst
diff --git a/docs/source/bigtree/tree/helper.rst → docs_sphinx/source/bigtree/tree/helper.rst b/docs/source/bigtree/tree/helper.rst → docs_sphinx/source/bigtree/tree/helper.rst
diff --git a/docs/source/bigtree/tree/modify.rst → docs_sphinx/source/bigtree/tree/modify.rst b/docs/source/bigtree/tree/modify.rst → docs_sphinx/source/bigtree/tree/modify.rst
@@ -91,8 +91,8 @@ All other methods calls these 2 methods directly.
 Tree Modification Illustration
 ----------------------------------
 
-.. image:: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/modify_shift_and_copy.png
-   :target: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/modify_shift_and_copy.png
+.. image:: https://github.com/kayjan/bigtree/raw/master/assets/docs/modify_shift_and_copy.png
+   :target: https://github.com/kayjan/bigtree/raw/master/assets/docs/modify_shift_and_copy.png
    :width: 80%
    :align: center
    :alt: Shift and Copy Example
@@ -126,8 +126,8 @@ Tree Modification Illustration
      - "/a/b/c"
      - Shift/copy node `c`, skip if "/a/c" cannot be found
 
-.. image:: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/modify_advanced.png
-   :target: https://github.com/kayjan/bigtree/raw/master/assets/sphinx/modify_advanced.png
+.. image:: https://github.com/kayjan/bigtree/raw/master/assets/docs/modify_advanced.png
+   :target: https://github.com/kayjan/bigtree/raw/master/assets/docs/modify_advanced.png
    :alt: Advanced Shift Example
 
 .. list-table:: Sample Tree Modification (Advanced)

diff --git a/docs/source/bigtree/tree/search.rst → docs_sphinx/source/bigtree/tree/search.rst b/docs/source/bigtree/tree/search.rst → docs_sphinx/source/bigtree/tree/search.rst
diff --git a/docs/source/bigtree/utils/iterators.rst → ...sphinx/source/bigtree/utils/iterators.rst b/docs/source/bigtree/utils/iterators.rst → ...sphinx/source/bigtree/utils/iterators.rst
diff --git a/docs/source/bigtree/utils/plot.rst → docs_sphinx/source/bigtree/utils/plot.rst b/docs/source/bigtree/utils/plot.rst → docs_sphinx/source/bigtree/utils/plot.rst
diff --git a/...source/bigtree/workflows/app_calendar.rst → ...source/bigtree/workflows/app_calendar.rst b/...source/bigtree/workflows/app_calendar.rst → ...source/bigtree/workflows/app_calendar.rst
diff --git a/docs/source/bigtree/workflows/app_todo.rst → ...inx/source/bigtree/workflows/app_todo.rst b/docs/source/bigtree/workflows/app_todo.rst → ...inx/source/bigtree/workflows/app_todo.rst
diff --git a/docs/source/binarytree.rst → docs_sphinx/source/binarytree.rst b/docs/source/binarytree.rst → docs_sphinx/source/binarytree.rst
diff --git a/docs/source/conf.py → docs_sphinx/source/conf.py b/docs/source/conf.py → docs_sphinx/source/conf.py
diff --git a/docs/source/dag.rst → docs_sphinx/source/dag.rst b/docs/source/dag.rst → docs_sphinx/source/dag.rst
diff --git a/docs/source/demo/binarytree.md → docs_sphinx/source/demo/binarytree.md b/docs/source/demo/binarytree.md → docs_sphinx/source/demo/binarytree.md
@@ -25,10 +25,10 @@ g = BinaryNode(7, parent=c)
 h = BinaryNode(8, parent=d)
 
 graph = tree_to_dot(a, node_colour="gold")
-graph.write_png("assets/docs/demo_binarytree.png")
+graph.write_png("assets/demo/binarytree.png")
 ```
 
-![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_binarytree.png)
+![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/demo/binarytree.png)
 
 ### 2. From list
 

diff --git a/docs/source/demo/dag.md → docs_sphinx/source/demo/dag.md b/docs/source/demo/dag.md → docs_sphinx/source/demo/dag.md
@@ -25,10 +25,10 @@ h = DAGNode("h")
 g = DAGNode("g", parents=[c], children=[h])
 
 graph = dag_to_dot(a, node_colour="gold")
-graph.write_png("assets/docs/demo_dag.png")
+graph.write_png("assets/demo/dag.png")
 ```
 
-![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_dag.png)
+![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/demo/dag.png)
 
 ### 2. From list
 

diff --git a/docs/source/demo/tree.md → docs_sphinx/source/demo/tree.md b/docs/source/demo/tree.md → docs_sphinx/source/demo/tree.md
@@ -38,10 +38,10 @@ root.hshow()
 #      └─ c
 
 graph = tree_to_dot(root, node_colour="gold")
-graph.write_png("assets/docs/demo_tree.png")
+graph.write_png("assets/demo/tree.png")
 ```
 
-![Sample Tree Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_tree.png)
+![Sample Tree Output](https://github.com/kayjan/bigtree/raw/master/assets/demo/tree.png)
 
 {emphasize-lines="8-10"}
 ```python
@@ -908,11 +908,11 @@ tree_to_dataframe(
 from bigtree import tree_to_dot
 
 graph = tree_to_dot(root, node_colour="gold")
-graph.write_png("assets/docs/demo_dot.png")
+graph.write_png("assets/demo/dot.png")
 ```
-- demo_dot.png
+- dot.png
 
-![Sample Dot Image Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_dot.png)
+![Sample Dot Image Output](https://github.com/kayjan/bigtree/raw/master/assets/demo/dot.png)
 
 ### 6. Export to Pillow (and png)
 
@@ -921,11 +921,11 @@ graph.write_png("assets/docs/demo_dot.png")
 from bigtree import tree_to_pillow
 
 pillow_image = tree_to_pillow(root)
-pillow_image.save("assets/docs/demo_pillow.png")
+pillow_image.save("assets/demo/pillow.png")
 ```
-- demo_pillow.png
+- pillow.png
 
-![Sample Pillow Image Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/demo_pillow.png)
+![Sample Pillow Image Output](https://github.com/kayjan/bigtree/raw/master/assets/demo/pillow.png)
 
 ### 7. Export to Mermaid Flowchart (and md)
 

diff --git a/docs/source/demo/workflow.md → docs_sphinx/source/demo/workflow.md b/docs/source/demo/workflow.md → docs_sphinx/source/demo/workflow.md
diff --git a/docs/source/index.rst → docs_sphinx/source/index.rst b/docs/source/index.rst → docs_sphinx/source/index.rst
diff --git a/docs/source/node.rst → docs_sphinx/source/node.rst b/docs/source/node.rst → docs_sphinx/source/node.rst
diff --git a/docs/source/others.rst → docs_sphinx/source/others.rst b/docs/source/others.rst → docs_sphinx/source/others.rst
diff --git a/docs/source/others/changelog.rst → docs_sphinx/source/others/changelog.rst b/docs/source/others/changelog.rst → docs_sphinx/source/others/changelog.rst
diff --git a/docs/source/others/contributing.rst → docs_sphinx/source/others/contributing.rst b/docs/source/others/contributing.rst → docs_sphinx/source/others/contributing.rst
diff --git a/docs/source/others/list_dir.md → docs_sphinx/source/others/list_dir.md b/docs/source/others/list_dir.md → docs_sphinx/source/others/list_dir.md
diff --git a/docs/source/others/merging_trees.md → docs_sphinx/source/others/merging_trees.md b/docs/source/others/merging_trees.md → docs_sphinx/source/others/merging_trees.md
diff --git a/docs/source/others/nodes.md → docs_sphinx/source/others/nodes.md b/docs/source/others/nodes.md → docs_sphinx/source/others/nodes.md
diff --git a/docs/source/others/tips.rst → docs_sphinx/source/others/tips.rst b/docs/source/others/tips.rst → docs_sphinx/source/others/tips.rst
diff --git a/docs/source/others/weighted_trees.md → docs_sphinx/source/others/weighted_trees.md b/docs/source/others/weighted_trees.md → docs_sphinx/source/others/weighted_trees.md
@@ -27,7 +27,7 @@ c = WeightedNode("c", parent=root, weight=2)
 d = WeightedNode("d", parent=b, weight=3)
 
 graph = tree_to_dot(root, node_colour="gold", edge_attr="edge_attr")
-graph.write_png("assets/sphinx/weighted_tree.png")
+graph.write_png("assets/docs/weighted_tree.png")
 ```
 
-![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/sphinx/weighted_tree.png)
+![Sample DAG Output](https://github.com/kayjan/bigtree/raw/master/assets/docs/weighted_tree.png)
diff --git a/docs/source/tree.rst → docs_sphinx/source/tree.rst b/docs/source/tree.rst → docs_sphinx/source/tree.rst
diff --git a/docs/source/utils.rst → docs_sphinx/source/utils.rst b/docs/source/utils.rst → docs_sphinx/source/utils.rst
diff --git a/docs/source/workflows.rst → docs_sphinx/source/workflows.rst b/docs/source/workflows.rst → docs_sphinx/source/workflows.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -84,11 +84,24 @@ dependencies = [
 ]
 
 [tool.hatch.envs.docs.scripts]
-html = "sphinx-build -M html docs/source docs/build"
-coverage = "sphinx-build -v -b coverage docs/source docs/build/coverage"
-doctest = "sphinx-build -v -b doctest docs/source docs/build/doctest"
-clean = "sphinx-build -M clean docs/source docs/build"
-clean-html = "sphinx-build -M html docs/source docs/build & sphinx-build -M clean docs/source docs/build"
+html = "sphinx-build -M html docs_sphinx/source docs_sphinx/build"
+coverage = "sphinx-build -v -b coverage docs_sphinx/source docs_sphinx/build/coverage"
+doctest = "sphinx-build -v -b doctest docs_sphinx/source docs_sphinx/build/doctest"
+clean = "sphinx-build -M clean docs_sphinx/source docs_sphinx/build"
+clean-html = "sphinx-build -M html docs_sphinx/source docs_sphinx/build & sphinx-build -M clean docs_sphinx/source docs_sphinx/build"
+
+[tool.hatch.envs.mkdocs]
+dependencies = [
+  "mkdocs",
+  "IPython",
+  "pandas",
+  "pydot",
+  "Pillow",
+]
+
+[tool.hatch.envs.mkdocs.scripts]
+build = "mkdocs build"
+serve = "mkdocs serve"
 
 [[tool.hatch.envs.test.matrix]]
 python = ["37", "38", "39", "310", "311"]
@@ -111,7 +124,7 @@ exclude_lines = [
 [tool.flake8]
 ignore = """E501, W503"""
 per-file-ignores = """
-  docs/source/conf.py: E402
+  docs_sphinx/source/conf.py: E402
   bigtree/__init__.py: F401
 """