Add filesystem to docs.

Author: fkdosilovic

docs/source/api/filesystem.rst

@@ -0,0 +1,6 @@
+Filesystem Module
+=================
+
+.. automodule:: judge0.filesystem
+   :members:
+   :member-order: bysource

docs/source/api/types.rst

@@ -34,6 +34,10 @@ Types
 Type aliases
 ------------
 
+.. autoclass:: judge0.base_types.Iterable
+   :members:
+   :member-order: bysource
+
 .. autoclass:: judge0.base_types.TestCaseType
    :members:
    :member-order: bysource

docs/source/index.rst

@@ -56,11 +56,12 @@ Every contribution, big or small, is valuable!
       :hidden:
 
       api/api
-      api/submission
       api/clients
-      api/types
-      api/retry
       api/errors
+      api/filesystem
+      api/retry
+      api/submission
+      api/types
 
 .. toctree::
       :caption: Getting Involved

src/judge0/filesystem.py

@@ -11,6 +11,16 @@
 
 
 class File(BaseModel):
+    """File object for storing file content.
+
+    Parameters
+    ----------
+    name : str
+        File name.
+    content : str or bytes, optional
+        File content. If str is provided, it will be encoded to bytes.
+    """
+
     name: str
     content: Optional[Union[str, bytes]] = None
 
@@ -29,6 +39,15 @@ def __str__(self):
 
 
 class Filesystem(BaseModel):
+    """Filesystem object for storing multiple files.
+
+    Parameters
+    ----------
+    content : str or bytes or File or Iterable[File] or Filesystem, optional
+        Filesystem content. If str or bytes is provided, it will be decoded to
+        files.
+    """
+
     files: list[File] = []
 
     def __init__(self, **data):
@@ -66,6 +85,7 @@ def __repr__(self) -> str:
         return f"{self.__class__.__name__}(content={content_encoded!r})"
 
     def encode(self) -> bytes:
+        """Encode Filesystem object to bytes."""
         zip_buffer = io.BytesIO()
         with zipfile.ZipFile(zip_buffer, "w") as zip_file:
             for file in self.files: