Skip to content

Commit 500597f

Browse files
authored
[DOCS-3220] Cross-link to driver API reference (#186)
1 parent 2c3c6dd commit 500597f

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,13 @@ The following versions of Python are supported:
2626
* Python 3.12
2727

2828

29+
## API reference
30+
31+
API reference documentation for the driver is available at
32+
https://fauna.github.io/fauna-python/. The docs are generated using
33+
[pdoc](https://pdoc.dev/docs/pdoc.html).
34+
35+
2936
## Basic Usage
3037
You can expect a ``Client`` instance to have reasonable defaults, like the Fauna endpoint ``https://db.fauna.com`` and a global HTTP client, but you will always need to configure a secret.
3138

concourse/scripts/publish_docs.sh

+3
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,9 @@ cd fauna-python-repository-updated-docs
3434
mkdir -p "${PACKAGE_VERSION}/api/"
3535
cp -R ../docs/* "./${PACKAGE_VERSION}/api/"
3636

37+
echo "Updating 'latest' symlink to point to $PACKAGE_VERSION"
38+
ln -sfn "$PACKAGE_VERSION" latest
39+
3740
git config --global user.email "[email protected]"
3841
git config --global user.name "Fauna, Inc"
3942

0 commit comments

Comments
 (0)