Add documentation and pre-commit

.flake8

@@ -0,0 +1,13 @@
+[flake8]
+# Black by its default setting the maximum length to 88
+max-line-length = 88
+extend-ignore = 
+    # also the Black's default, whitespace before ':'
+    E203,
+    # this is for the line length, all the lines too long are comments now
+    E501,
+    # the profile decorator is required
+    F821,
+    # some broken code under development, will come back
+    F841,
+

.gitignore

@@ -1,3 +1,5 @@
 __pycache__/
 .ipynb_checkpoints/
 .Rapp.history
+*build/
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/PyCQA/flake8
+    rev: 6.0.0
+    hooks:
+    -   id: flake8

.readthedocs.yaml

@@ -0,0 +1,19 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      - pip install sphinx-rtd-theme
+
+sphinx:
+  configuration: docs/source/conf.py
+
+python:
+  install:
+    - requirements: docs/source/requirements.txt
+
+formats:
+  - epub

.workflow/format.yml

@@ -0,0 +1,22 @@
+name: Evaluate code syntax
+on: [push, pull_request]
+
+jobs:
+    pre-commit_and_pytest:
+        name: Run pre-commit
+        strategy:
+          matrix:
+            os: [ubuntu-latest, Windows-latest, macos-latest]
+        runs-on: ${{ matrix.os }}
+        permissions:
+            contents: read
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Set up Python
+              uses: actions/setup-python@v4
+              with:
+                python-version: "3.11.x"
+
+            - uses: pre-commit/action@v3.0.0
+              name: Run pre-commit