Use MkDocs (#108)

* chore: 🧹 python.gitignore added

Signed-off-by: Onuralp SEZER <[email protected]>

* docs: 🧹 removal of old documents,packages,requirements

Signed-off-by: Onuralp SEZER <[email protected]>

* docs: ✨ mkdocs-material packages added as doc-dep

Signed-off-by: Onuralp SEZER <[email protected]>

* docs: ✨ initial mkdocs pages and documentation added, old docs removed

Signed-off-by: Onuralp SEZER <[email protected]>

* docs: ✨ set sphinx doc style as default

Signed-off-by: Onuralp SEZER <[email protected]>

* docs: ✨ decoders,exceptions,helper-functions,main-class,parsers,support-classes added

Signed-off-by: Onuralp SEZER <[email protected]>

* fix: 🐞 package typo fix

Signed-off-by: Onuralp SEZER <[email protected]>

* docs: ✨ home page, quickstart sections added

Signed-off-by: Onuralp SEZER <[email protected]>

* ci: 👷 docs workflow added

Signed-off-by: Onuralp SEZER <[email protected]>

* Apply my opinion

---------

Signed-off-by: Onuralp SEZER <[email protected]>
Co-authored-by: Marcelo Trylesinski <[email protected]>

.github/workflows/publish.yaml → .github/workflows/publish.yml

@@ -26,17 +26,17 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version: "3.10"
-
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install build
-
+        pip install -e '.[docs]'
     - name: Build package
       run: python -m build
-
     - name: Publish package
       uses: pypa/[email protected]
       with:
         user: __token__
         password: ${{ secrets.PYPI_API_TOKEN }}
+    - name: Publish docs
+      run: mkdocs gh-deploy --force

.gitignore

@@ -1,29 +1,6 @@
 # Project-specific ignores.
-venv/
 tmp/
 
-# Parts below taken from GitHub's gitignores repository: https://github.com/github/gitignore
-*.py[cod]
-
-# C extensions
-*.so
-
-# Packages
-*.egg
-*.egg-info
-MANIFEST
-dist
-/build
-eggs
-parts
-bin
-var
-sdist
-develop-eggs
-.installed.cfg
-lib
-lib64
-
 # Installer logs
 pip-log.txt
 
@@ -59,3 +36,165 @@ $RECYCLE.BIN/
 
 # OS X ignores
 .DS_Store
+
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/