Initial setup of doc structure.

fkdosilovic · fkdosilovic · commit 1b5898f41d57 · 2024-12-14T22:38:56.000+01:00
diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -0,0 +1,6 @@
+API Module
+==========
+
+.. automodule:: judge0.api
+   :members:
+   :undoc-members:
diff --git a/docs/source/api/clients.rst b/docs/source/api/clients.rst
@@ -0,0 +1,6 @@
+Clients Module
+==============
+
+.. automodule:: judge0.clients
+   :members:
+   :member-order: groupwise
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -0,0 +1,6 @@
+.. toctree::
+      :maxdepth: 2
+
+      api
+      submission
+      clients
diff --git a/docs/source/api/submission.rst b/docs/source/api/submission.rst
@@ -0,0 +1,6 @@
+Submission Module
+=================
+
+.. automodule:: judge0.submission
+   :members:
+   :member-order: groupwise
diff --git a/docs/source/api_index.rst b/docs/source/api_index.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -29,6 +29,8 @@
 exclude_patterns = []
 
 
+# add_module_names = False
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
diff --git a/docs/source/contributors_guide/contributing.rst b/docs/source/contributors_guide/contributing.rst
diff --git a/docs/source/contributors_guide/index.rst b/docs/source/contributors_guide/index.rst
@@ -0,0 +1,5 @@
+.. toctree::
+      :maxdepth: 2
+
+      contributing
+      release_notes
diff --git a/docs/source/contributors_guide/release_notes.rst b/docs/source/contributors_guide/release_notes.rst
@@ -0,0 +1,4 @@
+How to create a release candidate
+=================================
+
+TODO
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,9 +1,54 @@
+===============================
 Judge0 Python SDK documentation
 ===============================
 
+Getting Started
+===============
+
+You can run minimal Hello World example in three easy steps:
+
+1. Install Judge0 Python SDK:
+
+.. code-block:: bash
+
+    pip install judge0
+
+2. Create a minimal script:
+
+.. code-block:: Python
+
+    import judge0
+
+    submission = judge.run(source_code="print('Hello Judge0!')")
+    print(submission.stdout)
+
+3. Run the script.
+
+Want to learn more
+------------------
+
+
+To learn what is happening behind the scenes and how to best use Judge0 Python
+SDK to facilitate the development of your own product see In Depth guide and
+Examples.
+
+Getting Involved
+----------------
+
+TODO
+
+.. toctree::
+      :caption: Getting Involved
+      :glob:
+      :titlesonly:
+      :hidden:
+
+      contributors_guide/index
+
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents
+      :caption: API
+      :glob:
+      :titlesonly:
+      :hidden:
 
-   api_index
-   contributing
+      api/index
diff --git a/src/judge0/clients.py b/src/judge0/clients.py
@@ -1,4 +1,4 @@
-from typing import Optional, Union
+from typing import ClassVar, Optional, Union
 
 import requests
 
@@ -10,7 +10,7 @@
 
 
 class Client:
-    API_KEY_ENV = None
+    API_KEY_ENV: ClassVar[str] = None
 
     def __init__(
         self,
@@ -280,7 +280,7 @@ def get_submissions(
 class ATD(Client):
     """Base class for all AllThingsDev clients."""
 
-    API_KEY_ENV = "JUDGE0_ATD_API_KEY"
+    API_KEY_ENV: ClassVar[str] = "JUDGE0_ATD_API_KEY"
 
     def __init__(self, endpoint, host_header_value, api_key, **kwargs):
         self.api_key = api_key
@@ -300,21 +300,31 @@ def _update_endpoint_header(self, header_value):
 class ATDJudge0CE(ATD):
     """AllThingsDev client for CE flavor."""
 
-    DEFAULT_ENDPOINT: str = "https://judge0-ce.proxy-production.allthingsdev.co"
-    DEFAULT_HOST: str = "Judge0-CE.allthingsdev.co"
-    HOME_URL: str = (
+    DEFAULT_ENDPOINT: ClassVar[str] = (
+        "https://judge0-ce.proxy-production.allthingsdev.co"
+    )
+    DEFAULT_HOST: ClassVar[str] = "Judge0-CE.allthingsdev.co"
+    HOME_URL: ClassVar[str] = (
         "https://www.allthingsdev.co/apimarketplace/judge0-ce/66b683c8b7b7ad054eb6ff8f"
     )
 
-    DEFAULT_ABOUT_ENDPOINT: str = "01fc1c98-ceee-4f49-8614-f2214703e25f"
-    DEFAULT_CONFIG_INFO_ENDPOINT: str = "b7aab45d-5eb0-4519-b092-89e5af4fc4f3"
-    DEFAULT_LANGUAGE_ENDPOINT: str = "a50ae6b1-23c1-40eb-b34c-88bc8cf2c764"
-    DEFAULT_LANGUAGES_ENDPOINT: str = "03824deb-bd18-4456-8849-69d78e1383cc"
-    DEFAULT_STATUSES_ENDPOINT: str = "c37b603f-6f99-4e31-a361-7154c734f19b"
-    DEFAULT_CREATE_SUBMISSION_ENDPOINT: str = "6e65686d-40b0-4bf7-a12f-1f6d033c4473"
-    DEFAULT_GET_SUBMISSION_ENDPOINT: str = "b7032b8b-86da-40b4-b9d3-b1f5e2b4ee1e"
-    DEFAULT_CREATE_SUBMISSIONS_ENDPOINT: str = "402b857c-1126-4450-bfd8-22e1f2cbff2f"
-    DEFAULT_GET_SUBMISSIONS_ENDPOINT: str = "e42f2a26-5b02-472a-80c9-61c4bdae32ec"
+    DEFAULT_ABOUT_ENDPOINT: ClassVar[str] = "01fc1c98-ceee-4f49-8614-f2214703e25f"
+    DEFAULT_CONFIG_INFO_ENDPOINT: ClassVar[str] = "b7aab45d-5eb0-4519-b092-89e5af4fc4f3"
+    DEFAULT_LANGUAGE_ENDPOINT: ClassVar[str] = "a50ae6b1-23c1-40eb-b34c-88bc8cf2c764"
+    DEFAULT_LANGUAGES_ENDPOINT: ClassVar[str] = "03824deb-bd18-4456-8849-69d78e1383cc"
+    DEFAULT_STATUSES_ENDPOINT: ClassVar[str] = "c37b603f-6f99-4e31-a361-7154c734f19b"
+    DEFAULT_CREATE_SUBMISSION_ENDPOINT: ClassVar[str] = (
+        "6e65686d-40b0-4bf7-a12f-1f6d033c4473"
+    )
+    DEFAULT_GET_SUBMISSION_ENDPOINT: ClassVar[str] = (
+        "b7032b8b-86da-40b4-b9d3-b1f5e2b4ee1e"
+    )
+    DEFAULT_CREATE_SUBMISSIONS_ENDPOINT: ClassVar[str] = (
+        "402b857c-1126-4450-bfd8-22e1f2cbff2f"
+    )
+    DEFAULT_GET_SUBMISSIONS_ENDPOINT: ClassVar[str] = (
+        "e42f2a26-5b02-472a-80c9-61c4bdae32ec"
+    )
 
     def __init__(self, api_key, **kwargs):
         super().__init__(
@@ -374,22 +384,32 @@ def get_submissions(
 class ATDJudge0ExtraCE(ATD):
     """AllThingsDev client for Extra CE flavor."""
 
-    DEFAULT_ENDPOINT: str = "https://judge0-extra-ce.proxy-production.allthingsdev.co"
-    DEFAULT_HOST: str = "Judge0-Extra-CE.allthingsdev.co"
-    HOME_URL: str = (
+    DEFAULT_ENDPOINT: ClassVar[str] = (
+        "https://judge0-extra-ce.proxy-production.allthingsdev.co"
+    )
+    DEFAULT_HOST: ClassVar[str] = "Judge0-Extra-CE.allthingsdev.co"
+    HOME_URL: ClassVar[str] = (
         "https://www.allthingsdev.co/apimarketplace/judge0-extra-ce/"
         "66b68838b7b7ad054eb70690"
     )
 
-    DEFAULT_ABOUT_ENDPOINT: str = "1fd631a1-be6a-47d6-bf4c-987e357e3096"
-    DEFAULT_CONFIG_INFO_ENDPOINT: str = "46e05354-2a43-436a-9458-5d111456f0ff"
-    DEFAULT_LANGUAGE_ENDPOINT: str = "10465a84-2a2c-4213-845f-45e3c04a5867"
-    DEFAULT_LANGUAGES_ENDPOINT: str = "774ecece-1200-41f7-a992-38f186c90803"
-    DEFAULT_STATUSES_ENDPOINT: str = "a2843b3c-673d-4966-9a14-2e7d76dcd0cb"
-    DEFAULT_CREATE_SUBMISSION_ENDPOINT: str = "be2d195e-dd58-4770-9f3c-d6c0fbc2b6e5"
-    DEFAULT_GET_SUBMISSION_ENDPOINT: str = "c3a457cd-37a6-4106-97a8-9e60a223abbc"
-    DEFAULT_CREATE_SUBMISSIONS_ENDPOINT: str = "c64df5d3-edfd-4b08-8687-561af2f80d2f"
-    DEFAULT_GET_SUBMISSIONS_ENDPOINT: str = "5d173718-8e6a-4cf5-9d8c-db5e6386d037"
+    DEFAULT_ABOUT_ENDPOINT: ClassVar[str] = "1fd631a1-be6a-47d6-bf4c-987e357e3096"
+    DEFAULT_CONFIG_INFO_ENDPOINT: ClassVar[str] = "46e05354-2a43-436a-9458-5d111456f0ff"
+    DEFAULT_LANGUAGE_ENDPOINT: ClassVar[str] = "10465a84-2a2c-4213-845f-45e3c04a5867"
+    DEFAULT_LANGUAGES_ENDPOINT: ClassVar[str] = "774ecece-1200-41f7-a992-38f186c90803"
+    DEFAULT_STATUSES_ENDPOINT: ClassVar[str] = "a2843b3c-673d-4966-9a14-2e7d76dcd0cb"
+    DEFAULT_CREATE_SUBMISSION_ENDPOINT: ClassVar[str] = (
+        "be2d195e-dd58-4770-9f3c-d6c0fbc2b6e5"
+    )
+    DEFAULT_GET_SUBMISSION_ENDPOINT: ClassVar[str] = (
+        "c3a457cd-37a6-4106-97a8-9e60a223abbc"
+    )
+    DEFAULT_CREATE_SUBMISSIONS_ENDPOINT: ClassVar[str] = (
+        "c64df5d3-edfd-4b08-8687-561af2f80d2f"
+    )
+    DEFAULT_GET_SUBMISSIONS_ENDPOINT: ClassVar[str] = (
+        "5d173718-8e6a-4cf5-9d8c-db5e6386d037"
+    )
 
     def __init__(self, api_key, **kwargs):
         super().__init__(
@@ -449,7 +469,7 @@ def get_submissions(
 class Rapid(Client):
     """Base class for all RapidAPI clients."""
 
-    API_KEY_ENV = "JUDGE0_RAPID_API_KEY"
+    API_KEY_ENV: ClassVar[str] = "JUDGE0_RAPID_API_KEY"
 
     def __init__(self, endpoint, host_header_value, api_key, **kwargs):
         self.api_key = api_key
@@ -466,9 +486,9 @@ def __init__(self, endpoint, host_header_value, api_key, **kwargs):
 class RapidJudge0CE(Rapid):
     """RapidAPI client for CE flavor."""
 
-    DEFAULT_ENDPOINT: str = "https://judge0-ce.p.rapidapi.com"
-    DEFAULT_HOST: str = "judge0-ce.p.rapidapi.com"
-    HOME_URL: str = "https://rapidapi.com/judge0-official/api/judge0-ce"
+    DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-ce.p.rapidapi.com"
+    DEFAULT_HOST: ClassVar[str] = "judge0-ce.p.rapidapi.com"
+    HOME_URL: ClassVar[str] = "https://rapidapi.com/judge0-official/api/judge0-ce"
 
     def __init__(self, api_key, **kwargs):
         super().__init__(
@@ -482,9 +502,9 @@ def __init__(self, api_key, **kwargs):
 class RapidJudge0ExtraCE(Rapid):
     """RapidAPI client for Extra CE flavor."""
 
-    DEFAULT_ENDPOINT: str = "https://judge0-extra-ce.p.rapidapi.com"
-    DEFAULT_HOST: str = "judge0-extra-ce.p.rapidapi.com"
-    HOME_URL: str = "https://rapidapi.com/judge0-official/api/judge0-extra-ce"
+    DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-extra-ce.p.rapidapi.com"
+    DEFAULT_HOST: ClassVar[str] = "judge0-extra-ce.p.rapidapi.com"
+    HOME_URL: ClassVar[str] = "https://rapidapi.com/judge0-official/api/judge0-extra-ce"
 
     def __init__(self, api_key, **kwargs):
         super().__init__(
@@ -498,7 +518,7 @@ def __init__(self, api_key, **kwargs):
 class Sulu(Client):
     """Base class for all Sulu clients."""
 
-    API_KEY_ENV = "JUDGE0_SULU_API_KEY"
+    API_KEY_ENV: ClassVar[str] = "JUDGE0_SULU_API_KEY"
 
     def __init__(self, endpoint, api_key=None, **kwargs):
         self.api_key = api_key
@@ -512,8 +532,8 @@ def __init__(self, endpoint, api_key=None, **kwargs):
 class SuluJudge0CE(Sulu):
     """Sulu client for CE flavor."""
 
-    DEFAULT_ENDPOINT: str = "https://judge0-ce.p.sulu.sh"
-    HOME_URL: str = "https://sparkhub.sulu.sh/apis/judge0/judge0-ce/readme"
+    DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-ce.p.sulu.sh"
+    HOME_URL: ClassVar[str] = "https://sparkhub.sulu.sh/apis/judge0/judge0-ce/readme"
 
     def __init__(self, api_key=None, **kwargs):
         super().__init__(
@@ -526,8 +546,10 @@ def __init__(self, api_key=None, **kwargs):
 class SuluJudge0ExtraCE(Sulu):
     """Sulu client for Extra CE flavor."""
 
-    DEFAULT_ENDPOINT: str = "https://judge0-extra-ce.p.sulu.sh"
-    HOME_URL: str = "https://sparkhub.sulu.sh/apis/judge0/judge0-extra-ce/readme"
+    DEFAULT_ENDPOINT: ClassVar[str] = "https://judge0-extra-ce.p.sulu.sh"
+    HOME_URL: ClassVar[str] = (
+        "https://sparkhub.sulu.sh/apis/judge0/judge0-extra-ce/readme"
+    )
 
     def __init__(self, api_key=None, **kwargs):
         super().__init__(self.DEFAULT_ENDPOINT, api_key, **kwargs)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +How to create a release candidate
 +=================================
++
 +TODO