feat: (breaking) added docs, more examples in readme, renamed functio…

…ns, support action_graph as a function, refactorings (#2)

.pre-commit-config.yaml

@@ -3,20 +3,27 @@ repos:
     rev: v2.3.0
     hooks:
     -   id: check-yaml
-        exclude: README.md
+        exclude: README.md|docs/
     -   id: end-of-file-fixer
-        exclude: README.md
+        exclude: README.md|docs/
     -   id: trailing-whitespace
-        exclude: README.md
+        exclude: README.md|docs/
 
 - repo: local
   hooks:
-    - id: format-python
+    - id: make-format
       name: Python - autoflake, isort, black
       entry: bash -c 'make format'
       language: system
       files: \.(py|ipynb)$
       pass_filenames: false
+    # - id: make-docs
+    #   name: Generate docs using Sphinx
+    #   entry: bash -c 'make docs'
+    #   # track docs/ but ignore docs/_sources
+    #   files: ^docs/((?!_sources).)*$
+    #   language: system
+    #   pass_filenames: false
     - id: make-readme
       name: Generate readme from ipynb...
       entry: bash -c 'make readme'

Makefile

@@ -1,3 +1,5 @@
+.PHONY: docs
+
 format:
 	poetry run autoflake --remove-all-unused-imports --recursive --remove-unused-variables --in-place .  \
 	&& poetry run black --line-length 90 .  \
@@ -19,6 +21,17 @@ readme:
 	poetry run python -m nbconvert --to markdown --output README.md README.ipynb  \
 	&& poetry run python scripts/replace_readme_image_links.py
 
+docs:
+	cd docs_creator  \
+	&& $(MAKE) html  \
+	&& rm -rf ../docs  \
+	&& mkdir ../docs  \
+	&& cp -r build/html/* ../docs  \
+	&& touch ../docs/.nojekyll
+
+serve_docs: docs
+	cd docs && python -m http.server
+
 # run semantic release, publish to github + pypi
 release:
 	if poetry run semantic-release --strict version; then \