Skip to content

Commit e411013

Browse files
committed
resolve doc render issue
1 parent b769294 commit e411013

3 files changed

Lines changed: 16 additions & 16 deletions

File tree

docs/tutorials/python/migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ to the move.
4848
## 1. Set up and get project
4949

5050
```python
51-
--8<-- "docs/tutorials/python/tutorial_scripts/migration.py!lines:setup"
51+
--8<-- "docs/tutorials/python/tutorial_scripts/migration.py:setup"
5252
```
5353

5454
## 2. Index and migrate files
@@ -63,7 +63,7 @@ the database rather than aborting. Set `force=True` to skip the interactive
6363
confirmation prompt.
6464

6565
```python
66-
--8<-- "docs/tutorials/python/tutorial_scripts/migration.py!lines:index_and_migrate_files"
66+
--8<-- "docs/tutorials/python/tutorial_scripts/migration.py:index_and_migrate_files"
6767
```
6868

6969
Review the index CSV to confirm what was discovered before migration runs:

docs/tutorials/python/proxy_storage_location.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In this tutorial you will:
3131
## 1. Set up and get project
3232

3333
```python
34-
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py!lines:setup"
34+
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py:setup"
3535
```
3636

3737
## 2. Create a proxy storage location
@@ -42,7 +42,7 @@ access control is inherited from the project or folder. Assign it to a folder so
4242
files uploaded there are served through the proxy.
4343

4444
```python
45-
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py!lines:create_proxy_storage_location"
45+
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py:create_proxy_storage_location"
4646
```
4747

4848
<details class="example">
@@ -63,7 +63,7 @@ register a file that already exists on the proxy server by posting a
6363
size, and the relative path used by the proxy to serve it.
6464

6565
```python
66-
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py!lines:create_proxy_file_handle"
66+
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py:create_proxy_file_handle"
6767
```
6868

6969
<details class="example">
@@ -81,7 +81,7 @@ stores the metadata and uses the `ProxyFileHandle` to serve downloads through
8181
your proxy server.
8282

8383
```python
84-
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py!lines:associate_proxy_file_handle"
84+
--8<-- "docs/tutorials/python/tutorial_scripts/proxy_storage_location.py:associate_proxy_file_handle"
8585
```
8686

8787
## Source code for this tutorial

docs/tutorials/python/storage_location.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Common attributes are: `concrete_type`, `storage_location_id`, `storage_type`,
7575
## 1. Set up and get project
7676

7777
```python
78-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:setup"
78+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:setup"
7979
```
8080

8181
## 2. Create an external S3 storage location
@@ -85,7 +85,7 @@ properly configured with an `owner.txt` file. Synapse will transfer data
8585
directly to and from this bucket on the user's behalf.
8686

8787
```python
88-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_s3_storage_location"
88+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_s3_storage_location"
8989
```
9090

9191
<details class="example">
@@ -103,7 +103,7 @@ Create a folder and assign it the S3 storage location. All files uploaded into
103103
this folder will be stored in your S3 bucket.
104104

105105
```python
106-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_folder_with_s3_storage_location"
106+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_folder_with_s3_storage_location"
107107
```
108108

109109
<details class="example">
@@ -120,15 +120,15 @@ Create a storage location backed by a Google Cloud Storage bucket and assign it
120120
to a folder.
121121

122122
```python
123-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_gcs_storage_location"
123+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_gcs_storage_location"
124124
```
125125

126126
## 5. Create an SFTP storage location
127127

128128
SFTP storage locations point to an external SFTP server, where files are stored outside of Synapse. Synapse only manages the metadata and does not handle the file transfer itself. This setup requires the pysftp package, and files must be uploaded separately through the **client** once configured.
129129

130130
```python
131-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_sftp_storage_location"
131+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_sftp_storage_location"
132132
```
133133
## 6. Create an HTTPS storage location
134134

@@ -137,7 +137,7 @@ used when the external server is accessed over HTTPS. Note that the Python
137137
client does NOT support uploading files to HTTPS storage locations directly yet. To add files, use the Synapse REST API directly.
138138

139139
```python
140-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_https_storage_location"
140+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_https_storage_location"
141141
```
142142

143143
## 7. Create an External Object Store storage location
@@ -161,7 +161,7 @@ profile_name = my-s3-profile
161161
```
162162

163163
```python
164-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_object_store_storage_location"
164+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_object_store_storage_location"
165165
```
166166

167167
## 8. Create a Proxy storage location
@@ -171,7 +171,7 @@ authentication and access to the underlying storage. Files are registered by
171171
creating a `ProxyFileHandle` via the REST API. Then, files can be uploaded via store function with data_file_handle_id.
172172

173173
```python
174-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:create_proxy_storage_location"
174+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:create_proxy_storage_location"
175175
```
176176

177177
## 9. Retrieve and inspect storage location settings
@@ -180,7 +180,7 @@ You can retrieve a storage location by ID. Only fields relevant to the storage
180180
type are populated.
181181

182182
```python
183-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:retrieve_storage_location"
183+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:retrieve_storage_location"
184184
```
185185

186186
<details class="example">
@@ -201,7 +201,7 @@ creation. To "update" a storage location, create a new one with the desired
201201
settings and reassign it to the folder or project.
202202

203203
```python
204-
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py!lines:update_storage_location"
204+
--8<-- "docs/tutorials/python/tutorial_scripts/storage_location.py:update_storage_location"
205205
```
206206

207207
## References used in this tutorial

0 commit comments

Comments
 (0)