feat: add docs

joel@joellee.org · joel@joellee.org · commit afc563add778 · 2022-10-30T16:09:44.000+01:00
diff --git a/docs/source/api/api.rst b/docs/source/api/api.rst
@@ -0,0 +1,6 @@
+API
+======
+
+.. autoclass:: gotrue._async.api.AsyncGoTrueAPI
+    :inherited-members:
+
diff --git a/docs/source/api/client.rst b/docs/source/api/client.rst
@@ -0,0 +1,9 @@
+Client
+======
+
+The entrypoint to the library is the Client class. To interact with the Gotrue API, you make an instance of this class.
+
+
+.. autoclass:: gotrue.AsyncGoTrueClient
+    :members:
+    :inherited-members:
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
@@ -0,0 +1,14 @@
+API Reference
+=============
+
+.. note::
+    The library offers both synchronous and asynchronous clients.
+    Note that the synchronous and asynchronous classes all provide the exact same interface.
+    Only the async client and it's methods are documented here.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: API Reference:
+
+      Client <client>
+      API <api>
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,23 +17,29 @@
 # -- Project information -----------------------------------------------------
 
 project = "gotrue"
-copyright = "2021, Joel Lee"
-author = "Joel Lee"
+copyright = (
+    "2022, Anand Krishna, Daniel Reinón García, Joel Lee, Leynier Gutiérrez González"
+)
+author = "Anand Krishna, Daniel Reinón García, Joel Lee, Leynier Gutiérrez González"
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.extlinks",
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Options for HTML output -------------------------------------------------
 
diff --git a/docs/source/gotrue.rst b/docs/source/gotrue.rst
@@ -0,0 +1,53 @@
+gotrue package
+==============
+
+Submodules
+----------
+
+gotrue.constants module
+-----------------------
+
+.. automodule:: gotrue.constants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gotrue.exceptions module
+------------------------
+
+.. automodule:: gotrue.exceptions
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gotrue.helpers module
+---------------------
+
+.. automodule:: gotrue.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gotrue.http\_clients module
+---------------------------
+
+.. automodule:: gotrue.http_clients
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+gotrue.types module
+-------------------
+
+.. automodule:: gotrue.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: gotrue
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,8 +11,8 @@ Welcome to gotrue's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   usage/client
-   usage/admin
+      API Reference </api/index>
+      Examples </examples/index>
 
 
 
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+gotrue-py
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   gotrue
diff --git a/docs/source/usage/admin.rst b/docs/source/usage/admin.rst
diff --git a/docs/source/usage/client.rst b/docs/source/usage/client.rst

-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +API
 +======
++
 +.. autoclass:: gotrue._async.api.AsyncGoTrueAPI
 +    :inherited-members:
++