[chore] Add Generated Docs for GH Pages (#6)

.github/workflows/publish_docs.yml

@@ -0,0 +1,36 @@
+name: Publish Docs to Github Pages
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install Dependencies
+      run: |
+        pip install --upgrade pip
+        pip install .[dev]
+
+    - name: Build Sphinx Documentation
+      run: |
+        cd docs
+        make html
+
+    - name: Deploy to Github Pages
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/_build/html
+        keep_files: false
+
+

.gitignore

@@ -10,6 +10,8 @@
 
 .ruff_cache
 
+**/_build/
+
 venv/
 .venv/
 
@@ -22,3 +24,4 @@ env/
 \#*\#
 .\#*
 .projectile
+

Makefile

@@ -25,3 +25,7 @@ repl:
 .PHONY: install-deps
 install-deps:
 	pip install .[dev]
+
+.PHONY: docs
+docs:
+	sphinx-apidoc -o docs/ ./cdp/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -0,0 +1 @@
+../README.md

docs/cdp.client.api.rst

@@ -0,0 +1,149 @@
+cdp.client.api package
+======================
+
+Submodules
+----------
+
+cdp.client.api.addresses\_api module
+------------------------------------
+
+.. automodule:: cdp.client.api.addresses_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.assets\_api module
+---------------------------------
+
+.. automodule:: cdp.client.api.assets_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.balance\_history\_api module
+-------------------------------------------
+
+.. automodule:: cdp.client.api.balance_history_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.contract\_events\_api module
+-------------------------------------------
+
+.. automodule:: cdp.client.api.contract_events_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.contract\_invocations\_api module
+------------------------------------------------
+
+.. automodule:: cdp.client.api.contract_invocations_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.external\_addresses\_api module
+----------------------------------------------
+
+.. automodule:: cdp.client.api.external_addresses_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.networks\_api module
+-----------------------------------
+
+.. automodule:: cdp.client.api.networks_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.server\_signers\_api module
+------------------------------------------
+
+.. automodule:: cdp.client.api.server_signers_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.smart\_contracts\_api module
+-------------------------------------------
+
+.. automodule:: cdp.client.api.smart_contracts_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.stake\_api module
+--------------------------------
+
+.. automodule:: cdp.client.api.stake_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.trades\_api module
+---------------------------------
+
+.. automodule:: cdp.client.api.trades_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.transfers\_api module
+------------------------------------
+
+.. automodule:: cdp.client.api.transfers_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.users\_api module
+--------------------------------
+
+.. automodule:: cdp.client.api.users_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.validators\_api module
+-------------------------------------
+
+.. automodule:: cdp.client.api.validators_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.wallet\_stake\_api module
+----------------------------------------
+
+.. automodule:: cdp.client.api.wallet_stake_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.wallets\_api module
+----------------------------------
+
+.. automodule:: cdp.client.api.wallets_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+cdp.client.api.webhooks\_api module
+-----------------------------------
+
+.. automodule:: cdp.client.api.webhooks_api
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: cdp.client.api
+   :members:
+   :undoc-members:
+   :show-inheritance: