Skip to content

Commit

Permalink
reorganize documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
BWMac committed Jan 16, 2025
1 parent 7a3fd13 commit 2bcc349
Show file tree
Hide file tree
Showing 23 changed files with 328 additions and 272 deletions.
20 changes: 20 additions & 0 deletions docs/reference/experimental/async/activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Activity

## API Reference

::: synapseclient.models.Activity
options:
members:
- from_parent_async
- store_async
- delete_async
---
::: synapseclient.models.UsedEntity
options:
filters:
- "!"
---
::: synapseclient.models.UsedURL
options:
filters:
- "!"
2 changes: 2 additions & 0 deletions docs/reference/experimental/async/agent.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Agent

## API reference

::: synapseclient.models.Agent
options:
members:
Expand Down
23 changes: 23 additions & 0 deletions docs/reference/experimental/async/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# File

## API Reference

::: synapseclient.models.File
options:
inherited_members: true
members:
- get_async
- store_async
- copy_async
- delete_async
- from_id_async
- from_path_async
- change_metadata_async
- get_permissions_async
- get_acl_async
- set_permissions_async
---
::: synapseclient.models.file.FileHandle
options:
filters:
- "!"
16 changes: 16 additions & 0 deletions docs/reference/experimental/async/folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Folder

## API Reference

::: synapseclient.models.Folder
options:
inherited_members: true
members:
- get_async
- store_async
- delete_async
- copy_async
- sync_from_synapse_async
- get_permissions_async
- get_acl_async
- set_permissions_async
15 changes: 15 additions & 0 deletions docs/reference/experimental/async/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Project

## API reference

::: synapseclient.models.Project
options:
inherited_members: true
members:
- get_async
- store_async
- delete_async
- sync_from_synapse_async
- get_permissions_async
- get_acl_async
- set_permissions_async
17 changes: 17 additions & 0 deletions docs/reference/experimental/async/table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Table

## API Reference

::: synapseclient.models.Table
options:
inherited_members: true
members:
- get_async
- store_schema_async
- store_rows_from_csv_async
- delete_rows_async
- query_async
- delete_async
- get_permissions_async
- get_acl_async
- set_permissions_async
14 changes: 14 additions & 0 deletions docs/reference/experimental/async/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Team

## API Reference

::: synapseclient.models.Team
options:
members:
- create_async
- delete_async
- from_id_async
- from_name_async
- members_async
- invite_async
- open_invitations_async
11 changes: 11 additions & 0 deletions docs/reference/experimental/async/user_profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# UserProfile

## API Reference

::: synapseclient.models.UserProfile
options:
members:
- get_async
- from_id_async
- from_username_async
- is_certified_async
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/access_controllable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AccessControllable

::: synapseclient.models.mixins.AccessControllable
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AsynchronousCommunicator

::: synapseclient.models.mixins.AsynchronousCommunicator
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/failure_strategy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# FailureStrategy

::: synapseclient.models.FailureStrategy
3 changes: 3 additions & 0 deletions docs/reference/experimental/mixins/storable_container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# StorableContainer

::: synapseclient.models.mixins.StorableContainer
30 changes: 30 additions & 0 deletions docs/reference/experimental/sync/activity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Activity

## Example Script

<details class="quote">
<summary>Working with activities</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_activity.py!}
```
</details>

## API Reference

::: synapseclient.models.Activity
options:
members:
- from_parent
- store
- delete
---
::: synapseclient.models.UsedEntity
options:
filters:
- "!"
---
::: synapseclient.models.UsedURL
options:
filters:
- "!"
33 changes: 33 additions & 0 deletions docs/reference/experimental/sync/file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# File

## Example Script

<details class="quote">
<summary>Working with files</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_file.py!}
```
</details>

## API Reference

::: synapseclient.models.File
options:
inherited_members: true
members:
- get
- store
- copy
- delete
- from_id
- from_path
- change_metadata
- get_permissions
- get_acl
- set_permissions
---
::: synapseclient.models.file.FileHandle
options:
filters:
- "!"
26 changes: 26 additions & 0 deletions docs/reference/experimental/sync/folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Folder

## Example Script

<details class="quote">
<summary>Working with folders</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_folder.py!}
```
</details>

## API Reference

::: synapseclient.models.Folder
options:
inherited_members: true
members:
- get
- store
- delete
- copy
- sync_from_synapse
- get_permissions
- get_acl
- set_permissions
25 changes: 25 additions & 0 deletions docs/reference/experimental/sync/project.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Project

## Example Script

<details class="quote">
<summary>Working with a project</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_project.py!}
```
</details>

## API reference

::: synapseclient.models.Project
options:
inherited_members: true
members:
- get
- store
- delete
- sync_from_synapse
- get_permissions
- get_acl
- set_permissions
27 changes: 27 additions & 0 deletions docs/reference/experimental/sync/table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Table

## Example Script

<details class="quote">
<summary>Working with tables</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_table.py!}
```
</details>

## API Reference

::: synapseclient.models.Table
options:
inherited_members: true
members:
- get
- store_schema
- store_rows_from_csv
- delete_rows
- query
- delete
- get_permissions
- get_acl
- set_permissions
24 changes: 24 additions & 0 deletions docs/reference/experimental/sync/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Team

## Example Script

<details class="quote">
<summary>Working with teams</summary>

```python
{!docs/scripts/object_orientated_programming_poc/oop_poc_team.py!}
```
</details>

## API Reference

::: synapseclient.models.Team
options:
members:
- create
- delete
- from_id
- from_name
- members
- invite
- open_invitations
13 changes: 13 additions & 0 deletions docs/reference/experimental/sync/user_profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# UserProfile

## API Reference

::: synapseclient.models.UserProfile
options:
members:
- get
- from_id
- from_username
- is_certified
---
::: synapseclient.models.UserPreference
Loading

0 comments on commit 2bcc349

Please sign in to comment.