Skip to content

Commit 7c7e404

Browse files
docs: Restructure to developer-focused documentation
- Update index.md to point users to docs.datajoint.com - Create architecture/ section with transpilation docs - Archive user-facing content (now in datajoint-docs) - Simplify mkdocs.yaml for developer documentation - Update docstring style to numpy in mkdocs config User documentation is now at docs.datajoint.com. This site focuses on contributing, architecture, and API reference. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent ff04914 commit 7c7e404

File tree

128 files changed

+582
-139
lines changed

Some content is hidden

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

128 files changed

+582
-139
lines changed

DOCSTRING_STYLE.md

Lines changed: 499 additions & 0 deletions

docs/mkdocs.yaml

Lines changed: 18 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,17 @@
11
# ---------------------- PROJECT SPECIFIC ---------------------------
22

3-
site_name: DataJoint Documentation
3+
site_name: DataJoint Python - Developer Documentation
4+
site_description: Developer documentation for DataJoint Python contributors
45
repo_url: https://github.com/datajoint/datajoint-python
56
repo_name: datajoint/datajoint-python
67
nav:
7-
- DataJoint Python: index.md
8-
- Quick Start Guide: quick-start.md
9-
- 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
14-
- 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
24-
- 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 Codecs: design/tables/codecs.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
55-
- Fetch: query/fetch.md
56-
- Iteration: query/iteration.md
57-
- Operators: query/operators.md
58-
- Restrict: query/restrict.md
59-
- Projection: query/project.md
60-
- Join: query/join.md
61-
- Aggregation: query/aggregation.md
62-
- Union: query/union.md
63-
- 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
73-
- Tutorials:
74-
- JSON Datatype: tutorials/json.ipynb
75-
- FAQ: faq.md
76-
- Developer Guide: develop.md
77-
- Citation: citation.md
8+
- Home: index.md
9+
- Contributing: develop.md
10+
- Architecture:
11+
- architecture/index.md
12+
- SQL Transpilation: architecture/transpilation.md
7813
- Changelog: changelog.md
79-
- API: api/ # defer to gen-files + literate-nav
14+
- API Reference: api/ # defer to gen-files + literate-nav
8015

8116
# ---------------------------- STANDARD -----------------------------
8217

@@ -93,7 +28,7 @@ theme:
9328
favicon: assets/images/company-logo-blue.png
9429
features:
9530
- toc.integrate
96-
- content.code.annotate # Add codeblock annotations
31+
- content.code.annotate
9732
palette:
9833
- media: "(prefers-color-scheme: light)"
9934
scheme: datajoint
@@ -113,26 +48,18 @@ plugins:
11348
handlers:
11449
python:
11550
paths:
116-
- "."
117-
- /main/
51+
- "../src"
11852
options:
119-
filters:
120-
- "!^_"
121-
docstring_style: sphinx # Replaces google default pending docstring updates
53+
docstring_style: numpy
12254
members_order: source
12355
group_by_category: false
12456
line_length: 88
57+
show_source: false
12558
- gen-files:
12659
scripts:
12760
- ./src/api/make_pages.py
12861
- literate-nav:
12962
nav_file: navigation.md
130-
- exclude-search:
131-
exclude:
132-
- "*/navigation.md"
133-
- "*/archive/*md"
134-
- mkdocs-jupyter:
135-
include: ["*.ipynb"]
13663
- section-index
13764
markdown_extensions:
13865
- attr_list
@@ -154,41 +81,23 @@ markdown_extensions:
15481
- name: mermaid
15582
class: mermaid
15683
format: !!python/name:pymdownx.superfences.fence_code_format
157-
- pymdownx.magiclink # Displays bare URLs as links
158-
- pymdownx.tasklist: # Renders check boxes in tasks lists
84+
- pymdownx.magiclink
85+
- pymdownx.tasklist:
15986
custom_checkbox: true
16087
- md_in_html
16188
extra:
162-
generator: false # Disable watermark
89+
generator: false
16390
version:
16491
provider: mike
16592
social:
16693
- icon: main/company-logo
16794
link: https://www.datajoint.com
16895
name: DataJoint
169-
- icon: fontawesome/brands/slack
170-
link: https://datajoint.slack.com
171-
name: Slack
172-
- icon: fontawesome/brands/linkedin
173-
link: https://www.linkedin.com/company/datajoint
174-
name: LinkedIn
175-
- icon: fontawesome/brands/twitter
176-
link: https://twitter.com/datajoint
177-
name: Twitter
17896
- icon: fontawesome/brands/github
17997
link: https://github.com/datajoint
18098
name: GitHub
181-
- icon: fontawesome/brands/docker
182-
link: https://hub.docker.com/u/datajoint
183-
name: DockerHub
184-
- icon: fontawesome/brands/python
185-
link: https://pypi.org/user/datajointbot
186-
name: PyPI
187-
- icon: fontawesome/brands/stack-overflow
188-
link: https://stackoverflow.com/questions/tagged/datajoint
189-
name: StackOverflow
190-
- icon: fontawesome/brands/youtube
191-
link: https://www.youtube.com/channel/UCdeCuFOTCXlVMRzh6Wk-lGg
192-
name: YouTube
99+
- icon: fontawesome/brands/slack
100+
link: https://datajoint.slack.com
101+
name: Slack
193102
extra_css:
194103
- assets/stylesheets/extra.css

docs/src/architecture/index.md

Lines changed: 34 additions & 0 deletions

0 commit comments

Comments
 (0)