Add tutorial cross ref

tradingstrategy-ai · Apr 19, 2024 · 7ca6315 · 7ca6315
1 parent 0a08cbf
commit 7ca6315
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/source/tutorials/make-uniswap-v3-swap-in-python.rst b/docs/source/tutorials/make-uniswap-v3-swap-in-python.rst
@@ -1,3 +1,5 @@
+.. _uniswap-v3-swap:
+
 .. meta::
    :title: How to swap tokens on Uniswap v3 using Python
    :description: Python Uniswap 3 token swap tutorial

diff --git a/eth_defi/uniswap_v3/swap.py b/eth_defi/uniswap_v3/swap.py
@@ -1,4 +1,7 @@
-"""Uniswap v3 swap helper functions."""
+"""Uniswap v3 swap helper functions.
+
+- :ref:`Read full tutorial <uniswap-v3-swap>`_.
+"""
 import warnings
 from typing import Callable
 import logging
@@ -30,6 +33,8 @@ def swap_with_slippage_protection(
     """Helper function to prepare a swap from quote token to base token (buy base token with quote token)
     with price estimation and slippage protection baked in.
 
+    :ref:`Read full tutorial <uniswap-v3-swap>`_.
+
     Example:
 
     .. code-block:: python