Update docs and migrate to Python 3.13

.github/workflows/test.yaml

@@ -7,12 +7,12 @@ jobs:
     name: Run tests
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v4
-      with:
-        python-version: "3.9"
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
 
-    - run: pip install -r requirements.txt
-    - run: ape plugins install .
-    - run: ape compile --size
-    - run: ape test
+      - run: pip install -r requirements.txt
+      - run: ape plugins install .
+      - run: ape compile --size
+      - run: ape test

README.md

@@ -12,8 +12,7 @@
   <a href="https://github.com/CloudfloatAU/cloud-aud/actions/workflows/docs.yml"><img src="https://github.com/CloudfloatAU/cloud-aud/actions/workflows/docs.yml/badge.svg"></a>
 </div>
 
-
-## Table of contents
+# Table of contents
 
 - [Contract address](#contract-address)
 - [Usage](#usage)
@@ -23,15 +22,13 @@
   - [Coding style](#coding-style)
   - [Documentation](#documentation)
 
-
-## Contract address
+# Contract address
 
 Cloud AUD is currently **only** available on the **Polygon PoS** network.
 
 **The only official contract address is: [0xB1EF313E3119e13f827E14D7c90E03180ac828ed](https://polygonscan.com/token/0xb1ef313e3119e13f827e14d7c90e03180ac828ed)**
 
-
-## Usage
+# Usage
 
 This project uses [Vyper](https://vyper.readthedocs.io/en/stable/) via the
 [ape](https://github.com/apeWorX/ape) framework. Install the requirements and required
@@ -46,8 +43,7 @@ You will also most likely need an account (a.k.a. wallet) to perform any on-chai
 action.
 [Add an account via ape](https://docs.apeworx.io/ape/stable/userguides/accounts.html).
 
-
-### Deploy the contract
+## Deploy the contract
 
 To compile and deploy the contract, run:
 
@@ -56,10 +52,9 @@ ape compile
 ape run scripts/deploy.py --network ethereum:ropsten:geth
 ```
 
-*A funded account is required to deploy the contract.*
+_A funded account is required to deploy the contract._
 
-
-### Mint new tokens
+## Mint new tokens
 
 **⚠️ Only the creator of the contract or an account with minter role can mint new
 tokens!**
@@ -69,10 +64,9 @@ ape compile
 ape run scripts/mint.py --network ethereum:ropsten:geth
 ```
 
+# Contribute
 
-## Contribute
-
-### Coding style
+## Coding style
 
 This project uses [black](https://github.com/psf/black) code formatter, which is an
 extension of [PEP8](https://peps.python.org/pep-0008/).
@@ -91,9 +85,10 @@ black .
 # or format a single file
 black file.py
 ```
+
 </details>
 
-### Documentation
+## Documentation
 
 Docs are found in the `docs/` folder.
 

docs/requirements.txt

@@ -1,4 +1,5 @@
-Sphinx==5.2.2
-furo==2022.9.15
-myst-parser==0.18.1
-sphinx-copybutton==0.5.0
+Sphinx==8.1.3
+shibuya==2025.1.29
+sphinxcontrib-openapi==0.8.4
+myst-parser==4.0.0
+sphinx-copybutton==0.5.2

docs/src/conf.py

@@ -7,14 +7,14 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = "Cloud AUD"
-copyright = "2022, Cloudfloat"
+copyright = "2025, Cloudfloat"
 author = "Cloudfloat"
 
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["myst_parser", "sphinx_copybutton"]
+extensions = ["myst_parser", "sphinx_copybutton", "sphinxcontrib.openapi"]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
@@ -23,5 +23,5 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "furo"
+html_theme = "shibuya"
 html_static_path = ["_static"]

docs/src/developer-guide/api.rst

@@ -0,0 +1,4 @@
+Cloud AUD wallet API
+======================
+
+.. openapi:: openapi.json