From f68d5c64d85588976becc727d33c363d4dfc875c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?=
<16805946+edgarrmondragon@users.noreply.github.com>
Date: Tue, 16 Jul 2024 09:05:24 -0600
Subject: [PATCH] docs: Added more intersphinx links to Python and Faker docs
(#2535)
---
docs/conf.py | 1 +
docs/stream_maps.md | 17 ++++++++++-------
2 files changed, 11 insertions(+), 7 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index f5e45d3de..8d64411e4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -155,6 +155,7 @@
intersphinx_mapping = {
"requests": ("https://requests.readthedocs.io/en/latest/", None),
"python": ("https://docs.python.org/3/", None),
+ "faker": ("https://faker.readthedocs.io/en/master/", None),
}
# -- Options for linkcode --------------------------------------------------------------
diff --git a/docs/stream_maps.md b/docs/stream_maps.md
index a53e32580..66d647685 100644
--- a/docs/stream_maps.md
+++ b/docs/stream_maps.md
@@ -228,12 +228,13 @@ can be referenced directly by mapping expressions.
#### Built-In Functions
-- `md5()` - returns an inline MD5 hash of any string, outputting the string representation
- of the hash's hex digest.
+- [`md5()`](inv:python:py:module:#hashlib) - returns an inline MD5 hash of any string, outputting
+ the string representation of the hash's hex digest.
- This is defined by the SDK internally with native python:
- `hashlib.md5(.encode("utf-8")).hexdigest()`.
-- `datetime` - This is the datetime module object from the Python standard library. You can access
- datetime.datetime, datetime.timedelta, etc.
+ [`hashlib.md5(.encode("utf-8")).hexdigest()`](inv:python:py:method:#hashlib.hash.hexdigest).
+- [`datetime`](inv:python:py:module:#datetime) - This is the datetime module object from the Python
+ standard library. You can access [`datetime.datetime`](inv:python:py:class:#datetime.datetime),
+ [`datetime.timedelta`](inv:python:py:class:#datetime.timedelta), etc.
- [`json`](inv:python:py:module:#json) - This is the json module object from the Python standard
library. Primarily used for calling [`json.dumps()`](inv:python:py:function:#json.dumps)
and [`json.loads()`](inv:python:py:function:#json.loads).
@@ -245,10 +246,12 @@ can be referenced directly by mapping expressions.
- `record` - an alias for the record values dictionary in the current stream.
- `_` - same as `record` but shorter to type
- `self` - the existing property value if the property already exists
-- `fake` - a [`Faker`](https://faker.readthedocs.io/en/master/) instance, configurable via `faker_config` (see previous example) - see the built-in [standard providers](https://faker.readthedocs.io/en/master/providers.html) for available methods
+- `fake` - a [`Faker`](inv:faker:std:doc#index) instance, configurable via `faker_config`
+ (see previous example) - see the built-in [standard providers](inv:faker:std:doc#providers)
+ for available methods
```{tip}
- The `fake` object is only available if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra, or directly).
+ The `fake` object is only available if the plugin specifies `faker` as an additional dependency (through the `singer-sdk` `faker` extra, or directly).
```
#### Automatic Schema Detection