Update base types docs. Add scroll to top button in docs.

Author: fkdosilovic

docs/source/api/types.rst

@@ -1,6 +1,43 @@
 Types Module
 ============
 
-.. automodule:: judge0.base_types
+Types
+-----
+
+.. autoclass:: judge0.base_types.Config
+   :members:
+   :member-order: bysource
+
+.. autoclass:: judge0.base_types.Encodable
+   :members:
+
+.. autoclass:: judge0.base_types.Flavor
+   :members:
+   :member-order: bysource
+
+.. autoclass:: judge0.base_types.Language
+   :members:
+   :member-order: bysource
+
+.. autoclass:: judge0.base_types.LanguageAlias
    :members:
+   :member-order: bysource
 
+.. autoclass:: judge0.base_types.Status
+   :members:
+   :member-order: bysource
+
+.. autoclass:: judge0.base_types.TestCase
+   :members:
+   :member-order: bysource
+
+Type aliases
+------------
+
+.. autoclass:: judge0.base_types.TestCaseType
+   :members:
+   :member-order: bysource
+
+.. autoclass:: judge0.base_types.TestCases
+   :members:
+   :member-order: bysource

docs/source/conf.py

@@ -35,6 +35,9 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinxawesome_theme"
+html_theme_options = {
+    "show_scrolltop": True,
+}
 html_show_sphinx = False
 html_sidebars = {
     "**": [

src/judge0/base_types.py

@@ -1,7 +1,7 @@
 import copy
 
 from dataclasses import dataclass
-from enum import IntEnum, auto
+from enum import auto, IntEnum
 from typing import Optional, Protocol, runtime_checkable, Sequence, Union
 
 from pydantic import BaseModel
@@ -14,14 +14,27 @@
 
 @dataclass(frozen=True)
 class TestCase:
+    """Dataclass for test case."""
+
     input: Optional[str] = None
     expected_output: Optional[str] = None
 
     @classmethod
     def from_record(
         cls, test_case: Union[TestCaseType, None]
     ) -> Union["TestCase", None]:
-        """Create a TestCase from built-in types."""
+        """Create a TestCase from built-in types.
+
+        Parameters
+        ----------
+        test_case: :obj:`TestCaseType` or None
+            Test case data.
+
+        Returns
+        -------
+        TestCase or None
+            Created TestCase object or None if test_case is None.
+        """
         if isinstance(test_case, (tuple, list)):
             test_case = {
                 field: value
@@ -42,7 +55,7 @@ def from_record(
 
 
 @runtime_checkable
-class Encodeable(Protocol):
+class Encodable(Protocol):
     def encode(self) -> bytes:
         """Serialize the object to bytes."""
         ...
@@ -59,6 +72,7 @@ class Language(BaseModel):
 
 class LanguageAlias(IntEnum):
     """Language enumeration."""
+
     ASSEMBLY = auto()
     BASH = auto()
     BASIC = auto()

src/judge0/common.py

@@ -2,16 +2,16 @@
 from itertools import islice
 from typing import Union
 
-from judge0.base_types import Encodeable
+from judge0.base_types import Encodable
 
 
-def encode(content: Union[bytes, str, Encodeable]) -> str:
+def encode(content: Union[bytes, str, Encodable]) -> str:
     """Encode content to base64 string."""
     if isinstance(content, bytes):
         return b64encode(content).decode()
     if isinstance(content, str):
         return b64encode(content.encode()).decode()
-    if isinstance(content, Encodeable):
+    if isinstance(content, Encodable):
         return b64encode(content.encode()).decode()
     raise ValueError(f"Unsupported type. Expected bytes or str, got {type(content)}!")