Skip to content

Commit f68d5c6

Browse files
docs: Added more intersphinx links to Python and Faker docs (#2535)
1 parent 8348456 commit f68d5c6

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,7 @@
155155
intersphinx_mapping = {
156156
"requests": ("https://requests.readthedocs.io/en/latest/", None),
157157
"python": ("https://docs.python.org/3/", None),
158+
"faker": ("https://faker.readthedocs.io/en/master/", None),
158159
}
159160

160161
# -- Options for linkcode --------------------------------------------------------------

docs/stream_maps.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -228,12 +228,13 @@ can be referenced directly by mapping expressions.
228228

229229
#### Built-In Functions
230230

231-
- `md5()` - returns an inline MD5 hash of any string, outputting the string representation
232-
of the hash's hex digest.
231+
- [`md5()`](inv:python:py:module:#hashlib) - returns an inline MD5 hash of any string, outputting
232+
the string representation of the hash's hex digest.
233233
- This is defined by the SDK internally with native python:
234-
`hashlib.md5(<input>.encode("utf-8")).hexdigest()`.
235-
- `datetime` - This is the datetime module object from the Python standard library. You can access
236-
datetime.datetime, datetime.timedelta, etc.
234+
[`hashlib.md5(<input>.encode("utf-8")).hexdigest()`](inv:python:py:method:#hashlib.hash.hexdigest).
235+
- [`datetime`](inv:python:py:module:#datetime) - This is the datetime module object from the Python
236+
standard library. You can access [`datetime.datetime`](inv:python:py:class:#datetime.datetime),
237+
[`datetime.timedelta`](inv:python:py:class:#datetime.timedelta), etc.
237238
- [`json`](inv:python:py:module:#json) - This is the json module object from the Python standard
238239
library. Primarily used for calling [`json.dumps()`](inv:python:py:function:#json.dumps)
239240
and [`json.loads()`](inv:python:py:function:#json.loads).
@@ -245,10 +246,12 @@ can be referenced directly by mapping expressions.
245246
- `record` - an alias for the record values dictionary in the current stream.
246247
- `_` - same as `record` but shorter to type
247248
- `self` - the existing property value if the property already exists
248-
- `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
249+
- `fake` - a [`Faker`](inv:faker:std:doc#index) instance, configurable via `faker_config`
250+
(see previous example) - see the built-in [standard providers](inv:faker:std:doc#providers)
251+
for available methods
249252

250253
```{tip}
251-
The `fake` object is only available if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra, or directly).
254+
The `fake` object is only available if the plugin specifies `faker` as an additional dependency (through the `singer-sdk` `faker` extra, or directly).
252255
```
253256

254257
#### Automatic Schema Detection

0 commit comments

Comments
 (0)