Remove tables from docstrings. Render as numpy-based docs using napoleon extension.

fkdosilovic · fkdosilovic · commit 026b9b177dc1 · 2024-12-14T01:02:54.000+01:00
diff --git a/docs/source/api_index.rst b/docs/source/api_index.rst
@@ -1,19 +1,18 @@
 API
 ===
 
-.. toctree::
-   :maxdepth: 2
-   :caption: API
+.. autosummary::
+   :toctree: generated
 
-API
----
+API Module
+----------
 
 .. automodule:: judge0.api
    :members:
    :undoc-members:
 
-Submission
-----------
+Submission Module
+-----------------
 
 .. automodule:: judge0.submission
    :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,7 +18,11 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.autodoc"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autosummary",
+]
 
 templates_path = ["_templates"]
 exclude_patterns = []
@@ -48,3 +52,5 @@
     "special-members": False,
     "inherited-members": False,
 }
+
+napoleon_google_docstring = False
