Skip to content

Commit 5755984

Browse files
committed
Checkout current docs setup from scylla-4.x branch
Main motivation is getting myst parser in, so that documentation builds correctly for this version. Brings several changes that are in scylla-4.x as of commit c85f7b9
1 parent ef43e74 commit 5755984

File tree

6 files changed

+1427
-13
lines changed

6 files changed

+1427
-13
lines changed

docs/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,14 @@ setupenv:
2424
.PHONY: setup
2525
setup:
2626
$(POETRY) install
27-
$(POETRY) update
2827
@if [ ! -d "$(SOURCEDIR)" ]; then mkdir -p "$(SOURCEDIR)"; fi
2928
cp -RL source/* $(SOURCEDIR)
3029
cd $(SOURCEDIR) && find . -name README.md -execdir mv '{}' index.md ';'
3130

31+
.PHONY: update
32+
update:
33+
$(POETRY) update
34+
3235
# Clean commands
3336
.PHONY: pristine
3437
pristine: clean

docs/_utils/deploy.sh

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#!/bin/bash
2+
3+
# Copy contents
4+
mkdir gh-pages
5+
cp -r ./docs/_build/dirhtml/. gh-pages
6+
7+
# Create gh-pages branch
8+
cd gh-pages
9+
git init
10+
git config --local user.email "[email protected]"
11+
git config --local user.name "GitHub Action"
12+
git remote add origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
13+
git checkout -b gh-pages
14+
15+
# Deploy
16+
git add .
17+
git commit -m "Publish docs" || true
18+
git push origin gh-pages --force

docs/_utils/javadoc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ fi
1414
mvn javadoc:javadoc -T 1C
1515
[ -d $OUTPUT_DIR ] && rm -r $OUTPUT_DIR
1616
mkdir -p "$OUTPUT_DIR"
17-
mv -f core/target/site/apidocs/* $OUTPUT_DIR
17+
mv -f driver-core/target/site/apidocs/* $OUTPUT_DIR

0 commit comments

Comments
 (0)