Skip to content

Commit a657b19

Browse files
adjust symlink to preview docs (#1367)
1 parent d9cc278 commit a657b19

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Documentation
22

33
## Development
4+
Either link or clone the webknossos repository to `webknossos-libs/docs/src/webknossos`, e.g. with `git clone --depth 1 git@github.com:scalableminds/webknossos.git webknossos-libs/docs/src/webknossos` or by creating a symlink with `ln -s ../path/to/webknossos/docs src/webknossos`
5+
The symlink should look somewhat like this
6+
```
7+
webknossos-libs/docs/src$ ls -l webknossos
8+
webknossos -> ../../../webknossos/docs
9+
```
410
Run `./generate.sh` to open a live-reloading server rendering the documentation.
511

612
## Production

docs/generate.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
#! /usr/bin/env bash
22
set -Eeo pipefail
33

4-
if [ ! -d "wk-repo" ]; then
4+
if [ ! -d "src/webknossos" ]; then
55
echo
66
echo ERROR!
7-
echo 'Either link or clone the webknossos repository to "docs/wk-repo", e.g. with'
8-
echo 'git clone --depth 1 git@github.com:scalableminds/webknossos.git docs/wk-repo'
7+
echo 'Either link or clone the webknossos repository to "webknossos-libs/docs/src/webknossos", e.g. with'
8+
echo 'git clone --depth 1 git@github.com:scalableminds/webknossos.git webknossos-libs/docs/src/webknossos'
99
exit 1
1010
fi
1111
rm -rf src/api/webknossos

0 commit comments

Comments
 (0)