Skip to content

Commit d45d5b3

Browse files
docs: use datajoint-python pre/v2.0 branch for documentation
- CI now checks out pre/v2.0 branch instead of default branch - Updated README with instructions to clone pre/v2.0 for local development - Ensures documentation is built against pre-release 2.0 features
1 parent e8e737c commit d45d5b3

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/development.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ jobs:
1616
uses: actions/checkout@v2
1717
with:
1818
repository: datajoint/datajoint-python
19+
ref: pre/v2.0
1920
path: datajoint-python
2021
- name: Compile docs static artifacts
2122
run: |

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,15 @@ dependencies needed to build documentation and execute tutorial notebooks.
154154
### Start the Environment
155155

156156
```bash
157-
# Clone the repository
157+
# Clone the documentation repository
158158
git clone https://github.com/datajoint/datajoint-docs.git
159159
cd datajoint-docs
160160

161+
# Clone datajoint-python pre-release branch (required for API docs)
162+
cd ..
163+
git clone -b pre/v2.0 https://github.com/datajoint/datajoint-python.git
164+
cd datajoint-docs
165+
161166
# Start all services (MySQL, MinIO, docs server)
162167
MODE="LIVE" docker compose up --build
163168
```

0 commit comments

Comments
 (0)