Skip to content

Commit df682a5

Browse files
committed
Restructure documentation navigation and file organization
- Reorganize nav to: Getting Started, Concepts, Schema Design, Data Types, Data Operations, Queries, Administration, Reference - Create datatypes/ section (blob, attach, filepath, object, adapters) - Merge manipulation/ + compute/ into operations/ - Move sysadmin/ to admin/ - Consolidate concepts to minimal index linking to DataJoint Book - Remove theoretical pages (normalization, integrity, recall) - Move reference files (faq, develop, citation, transpilation)
1 parent 2979769 commit df682a5

31 files changed

+84
-1174
lines changed

docs/mkdocs.yaml

Lines changed: 53 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -4,78 +4,70 @@ site_name: DataJoint Documentation
44
repo_url: https://github.com/datajoint/datajoint-python
55
repo_name: datajoint/datajoint-python
66
nav:
7-
- DataJoint Python: index.md
8-
- Quick Start Guide: quick-start.md
7+
- Home: index.md
8+
- Quick Start: quick-start.md
99
- Concepts:
10-
- Principles: concepts/principles.md
11-
- Data Model: concepts/data-model.md
12-
- Data Pipelines: concepts/data-pipelines.md
13-
- Teamwork: concepts/teamwork.md
10+
- concepts/index.md
1411
- Terminology: concepts/terminology.md
15-
- System Administration:
16-
- Database Administration: sysadmin/database-admin.md
17-
- Bulk Storage Systems: sysadmin/bulk-storage.md
18-
- External Store: sysadmin/external-store.md
19-
- Client Configuration:
20-
- Install: client/install.md
21-
- Credentials: client/credentials.md
22-
- Settings: client/settings.md
23-
- File Stores: client/stores.md
12+
- Getting Started:
13+
- Installation: client/install.md
14+
- Connection: client/credentials.md
15+
- Configuration: client/settings.md
2416
- Schema Design:
25-
- Schema Creation: design/schema.md
26-
- Table Definition:
27-
- Table Tiers: design/tables/tiers.md
28-
- Declaration Syntax: design/tables/declare.md
29-
- Primary Key: design/tables/primary.md
30-
- Attributes: design/tables/attributes.md
31-
- Lookup Tables: design/tables/lookup.md
32-
- Manual Tables: design/tables/manual.md
33-
- Blobs: design/tables/blobs.md
34-
- Attachments: design/tables/attach.md
35-
- Filepaths: design/tables/filepath.md
36-
- Custom Datatypes: design/tables/customtype.md
37-
- Dependencies: design/tables/dependencies.md
38-
- Indexes: design/tables/indexes.md
39-
- Master-Part Relationships: design/tables/master-part.md
40-
- Schema Diagrams: design/diagrams.md
41-
- Entity Normalization: design/normalization.md
42-
- Data Integrity: design/integrity.md
43-
- Schema Recall: design/recall.md
44-
- Schema Drop: design/drop.md
45-
- Schema Modification: design/alter.md
46-
- Data Manipulations:
47-
- manipulation/index.md
48-
- Insert: manipulation/insert.md
49-
- Delete: manipulation/delete.md
50-
- Update: manipulation/update.md
51-
- Transactions: manipulation/transactions.md
52-
- Data Queries:
53-
- Principles: query/principles.md
54-
- Example Schema: query/example-schema.md
17+
- Schemas: design/schema.md
18+
- Table Tiers: design/tables/tiers.md
19+
- Declaration: design/tables/declare.md
20+
- Primary Key: design/tables/primary.md
21+
- Attributes: design/tables/attributes.md
22+
- Foreign Keys: design/tables/dependencies.md
23+
- Indexes: design/tables/indexes.md
24+
- Lookup Tables: design/tables/lookup.md
25+
- Manual Tables: design/tables/manual.md
26+
- Master-Part: design/tables/master-part.md
27+
- Diagrams: design/diagrams.md
28+
- Alter: design/alter.md
29+
- Drop: design/drop.md
30+
- Data Types:
31+
- Blob: datatypes/blob.md
32+
- Attach: datatypes/attach.md
33+
- Filepath: datatypes/filepath.md
34+
- Object: datatypes/object.md
35+
- Adapted Types: datatypes/adapters.md
36+
- Data Operations:
37+
- operations/index.md
38+
- Insert: operations/insert.md
39+
- Delete: operations/delete.md
40+
- Update: operations/update.md
41+
- Transactions: operations/transactions.md
42+
- Make Method: operations/make.md
43+
- Populate: operations/populate.md
44+
- Key Source: operations/key-source.md
45+
- Distributed: operations/distributed.md
46+
- Queries:
47+
- query/principles.md
5548
- Fetch: query/fetch.md
56-
- Iteration: query/iteration.md
5749
- Operators: query/operators.md
5850
- Restrict: query/restrict.md
59-
- Projection: query/project.md
51+
- Project: query/project.md
6052
- Join: query/join.md
6153
- Aggregation: query/aggregation.md
6254
- Union: query/union.md
6355
- Universal Sets: query/universals.md
64-
- Query Caching: query/query-caching.md
65-
- Computations:
66-
- Make Method: compute/make.md
67-
- Populate: compute/populate.md
68-
- Key Source: compute/key-source.md
69-
- Distributed Computing: compute/distributed.md
70-
- Publish Data: publish-data.md
71-
- Internals:
72-
- SQL Transpilation: internal/transpilation.md
56+
- Iteration: query/iteration.md
57+
- Caching: query/query-caching.md
58+
- Administration:
59+
- Database: admin/database.md
60+
- Storage Backends: admin/storage.md
61+
- External Store: admin/external-store.md
7362
- Tutorials:
74-
- JSON Datatype: tutorials/json.ipynb
75-
- FAQ: faq.md
76-
- Developer Guide: develop.md
77-
- Citation: citation.md
78-
- Changelog: changelog.md
63+
- JSON Datatype: tutorials/json.ipynb
64+
- Reference:
65+
- FAQ: reference/faq.md
66+
- SQL Transpilation: reference/transpilation.md
67+
- Publishing Data: reference/publish-data.md
68+
- Developer Guide: reference/develop.md
69+
- Citation: reference/citation.md
70+
- Changelog: changelog.md
7971
- API: api/ # defer to gen-files + literate-nav
8072

8173
# ---------------------------- STANDARD -----------------------------
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/src/concepts/data-model.md

Lines changed: 0 additions & 172 deletions
This file was deleted.

0 commit comments

Comments
 (0)