Fix/design doc (#422)

* UPD docs

* Add docs for normalization

* Fix linter issue

* Fix version

Author: IINemo

docs/conf.py

@@ -16,26 +16,32 @@
 # -- Auto-generate API documentation -----------------------------------------
 # Run sphinx-apidoc automatically when building docs
 
+
 def run_apidoc(_):
     from sphinx.ext.apidoc import main as apidoc_main
-    
+
     docs_dir = Path(__file__).parent
     output_dir = docs_dir / "api"  # Output .rst files to docs/
     source_dir = docs_dir.parent / "src" / "lm_polygraph"
-    
+
     # Only run if source directory exists
     if source_dir.exists():
-        apidoc_main([
-            "--force",  # Overwrite existing files
-            "--module-first",  # Put module documentation before submodule documentation
-            "--separate",  # Create separate pages for each module
-            "-o", str(output_dir),
-            str(source_dir),
-        ])
+        apidoc_main(
+            [
+                "--force",  # Overwrite existing files
+                "--module-first",  # Put module documentation before submodule documentation
+                "--separate",  # Create separate pages for each module
+                "-o",
+                str(output_dir),
+                str(source_dir),
+            ]
+        )
+
 
 def setup(app):
     app.connect("builder-inited", run_apidoc)
 
+
 project = "LM-Polygraph"
 author = "MBZUAI"
 copyright = f"{datetime.now().year}, {author}"

docs/usage.rst

@@ -26,7 +26,7 @@ However code from the main branch may be unstable, so it is recommended to check
 .. code-block:: console
     
     $ git clone https://github.com/IINemo/lm-polygraph.git
-    $ git checkout tags/v0.3.0
+    $ git checkout tags/v0.5.0
     $ python3 -m venv env
     $ source env/bin/activate
     (env) $ cd lm-polygraph
@@ -49,7 +49,7 @@ To install a specific version, run:
 
     $ python3 -m venv env
     $ source env/bin/activate
-    $ pip install lm-polygraph==0.3.0
+    $ pip install lm-polygraph==0.5.0
 
 .. _quick_start: