setup the Documentation.

Author: codewithdark-git

.readthedocs.yaml

@@ -0,0 +1,22 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - dev
+    - requirements: docs/requirements.txt
+
+formats:
+  - pdf
+  - epub

docs/conf.py

@@ -8,6 +8,9 @@
 version = '0.1.0'
 release = '0.1.0'
 
+# RTD configurations
+on_rtd = os.environ.get('READTHEDOCS') == 'True'
+
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
@@ -24,16 +27,38 @@
 html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
+# Configure intersphinx mapping
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     'torch': ('https://pytorch.org/docs/stable', None),
     'transformers': ('https://huggingface.co/transformers/master', None),
 }
 
+# Autodoc configurations
 autodoc_default_options = {
     'members': True,
     'member-order': 'bysource',
     'special-members': '__init__',
     'undoc-members': True,
     'exclude-members': '__weakref__'
-}
+}
+
+# Napoleon settings
+napoleon_google_docstring = True
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+napoleon_use_admonition_for_references = True
+napoleon_use_ivar = False
+napoleon_use_param = True
+napoleon_use_rtype = True
+napoleon_type_aliases = None
+
+# MyST parser settings
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist"
+]

docs/requirements.txt

@@ -0,0 +1,17 @@
+sphinx>=4.5.0
+sphinx-rtd-theme>=1.0.0
+sphinx-copybutton>=0.5.0
+sphinx-autodoc-typehints>=1.18.3
+myst-parser>=0.18.1
+# Package dependencies
+torch>=2.0.0
+transformers>=4.30.0
+datasets>=2.12.0
+accelerate>=0.20.0
+peft>=0.4.0
+bitsandbytes>=0.40.0
+scipy>=1.10.0
+scikit-learn>=1.0.0
+tqdm>=4.65.0
+numpy>=1.24.0
+wandb>=0.15.0