Skip to content

Commit 40a6794

Browse files
dimitri-yatsenkodimitri-yatsenko
authored
Merge pull request #1087 from kabilar/master
Add skeleton from `datajoint-company/datajoint-docs` repo for docs migration
2 parents 97e34a6 + bdca988 commit 40a6794

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1233
-173
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- Changed - Docs to add landing page and update navigation
88
- Changed - `.data` method to `.stream` in the `get()` method for S3 (external) objects PR [#1085](https://github.com/datajoint/datajoint-python/pull/1085)
99
- Fixed - Docs to rename `create_virtual_module` to `VirtualModule`
10+
- Added - Skeleton from `datajoint-company/datajoint-docs` repository for docs migration
1011

1112
### 0.14.0 -- Feb 13, 2023
1213
- Added - `json` data type ([#245](https://github.com/datajoint/datajoint-python/issues/245)) PR [#1051](https://github.com/datajoint/datajoint-python/pull/1051)

‎docs/mkdocs.yaml

Lines changed: 59 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,72 @@ repo_name: datajoint/datajoint-python
66
nav:
77
- DataJoint Python: index.md
88
- Getting Started: getting-started/index.md
9-
- Existing Pipelines: concepts/existing-pipelines.md
10-
- Query Language:
11-
- Common Commands: query-lang/common-commands.md
12-
- Operators: query-lang/operators.md
13-
- Iteration: query-lang/iteration.md
14-
- Query Caching: query-lang/query-caching.md
9+
- Concepts:
10+
- Principles: concepts/principles.md
11+
- Glossary: concepts/glossary.md
12+
- System Administration:
13+
- Database Administration: sysadmin/dba.md
14+
- File Storage: sysadmin/filestore.md
15+
- Client Configuration:
16+
- Install: client/install.md
17+
- Credentials: client/creds.md
18+
- Settings: client/settings.md
19+
- File Stores: client/stores.md
20+
- Schema Design:
21+
- Schema Creation: design/schema.md
22+
- Table Definition:
23+
- Table Tiers: design/tables/tiers.md
24+
- Declaration Syntax: design/tables/declare.md
25+
- Primary Key: design/tables/primary.md
26+
- Attributes: design/tables/attributes.md
27+
- Lookup Tables: design/tables/lookup.md
28+
- Blobs: design/tables/blobs.md
29+
- Attachments: design/tables/attach.md
30+
- Filepaths: design/tables/filepath.md
31+
- Custom Datatypes: design/tables/customtype.md
32+
- Dependencies: design/tables/dependencies.md
33+
- Indexes: design/tables/indexes.md
34+
- Master-Part Relationships: design/tables/master-part.md
35+
- Schema Diagrams: design/diagrams.md
36+
- Entity Normalization: design/normalization.md
37+
- Data Integrity: design/integrity.md
38+
- Schema Recall: design/recall.md
39+
- Schema Drop: design/drop.md
40+
- Schema Modification: design/alter.md
41+
- Data Manipulations:
42+
- Insert: manipulation/insert.md
43+
- Delete: manipulation/delete.md
44+
- Update: manipulation/update.md
45+
- Transactions: manipulation/transactions.md
46+
- Data Queries:
47+
- Common Commands: query/common-commands.md
48+
- Fetch: query/fetch.md
49+
- Iteration: query/iteration.md
50+
- Operators: query/operators.md
51+
- Restrict: query/restrict.md
52+
- Projection: query/project.md
53+
- Join: query/join.md
54+
- Aggregation: query/aggregation.md
55+
- Union: query/union.md
56+
- Universal Sets: query/universals.md
57+
- Query Caching: query/query-caching.md
58+
- Computations:
59+
- Make Method: compute/make.md
60+
- Populate: compute/populate.md
61+
- Key Source: compute/key-source.md
62+
- Distributed Computing: compute/distributed.md
63+
- Internals:
64+
- SQL Transpilation: internal/transpilation.md
1565
- Reproducibility:
1666
- Table Tiers: reproduce/table-tiers.md
1767
- Make Method: reproduce/make-method.md
68+
- Existing Pipelines: existing-pipelines.md
1869
- Tutorials:
1970
- tutorials/json.ipynb
71+
- FAQ: faq.md
2072
- Develop: develop.md
2173
- Citation: citation.md
22-
- Changelog: about/changelog.md
74+
- Changelog: changelog.md
2375
- API: api/ # defer to gen-files + literate-nav
2476

2577
# ---------------------------- STANDARD -----------------------------

‎docs/src/about/changelog.md renamed to ‎docs/src/changelog.md

File renamed without changes.

‎docs/src/client/creds.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Work in progress
2+
You may ask questions in the chat window below or
3+
refer to [legacy documentation](https://docs.datajoint.org/)

‎docs/src/client/install.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Work in progress
2+
You may ask questions in the chat window below or
3+
refer to [legacy documentation](https://docs.datajoint.org/)

‎docs/src/client/settings.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Work in progress
2+
You may ask questions in the chat window below or
3+
refer to [legacy documentation](https://docs.datajoint.org/)

‎docs/src/client/stores.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Work in progress
2+
You may ask questions in the chat window below or
3+
refer to [legacy documentation](https://docs.datajoint.org/)

‎docs/src/compute/distributed.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Work in progress
2+
You may ask questions in the chat window below or
3+
refer to [legacy documentation](https://docs.datajoint.org/)

‎docs/src/compute/key-source.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Work in progress
2+
You may ask questions in the chat window below or
3+
refer to [legacy documentation](https://docs.datajoint.org/)

‎docs/src/compute/make.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Make Method
2+
3+
For auto-populated *Imported* and *Computed* tables[^1], a `make` method gives exact
4+
instructions for generating the content. By making these steps explicit, we keep a
5+
careful record of data provenance and ensure reproducibility. Data should never be
6+
entered using the `insert` method directly.
7+
8+
[^1]: For information on differentiating these data tiers, see the Table Tier section on
9+
[Automation](../design/tables/tiers#automation-imported-and-computed).
10+
11+
The `make` method receives one argument: the *key*, which represents the upstream table
12+
entries that need populating. The `key` is a `dict` in Python.
13+
14+
A `make` function should do three things:
15+
16+
1. [Fetch](../query/common-commands#fetch) data from tables upstream in the
17+
pipeline using the key for restriction.
18+
19+
2. Compute and add any missing attributes to the fields already in the key.
20+
21+
3. [Inserts](../query/common-commands#insert) the entire entity into the
22+
triggering table.
23+
24+
## Populate
25+
26+
The `make` method is sometimes referred to as the `populate` function because this is
27+
the class method called to run the `make` method on all relevant keys[^2].
28+
29+
[^2]: For information on reprocessing keys that resulted in an error, see information
30+
on the [Jobs table](./distributed).
31+
32+
``` python
33+
Segmentation.populate()
34+
```

0 commit comments

Comments
 (0)