Skip to content

Commit c60303b

Browse files
committed
Added API references to mkdocs, added build script
1 parent 3f7f4d8 commit c60303b

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

build-doc.sh

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# #Set up python environment
2+
#pyenv local 3.10.1
3+
#pip install mkdocs mkdocs-material pip install mkdocs-awesome-pages-plugin
4+
5+
# Build Javadoc
6+
# Potentially need to `mvn clean install -DskipTests` first
7+
mvn javadoc:javadoc -pl core,query-builder,mapper-runtime
8+
mvn javadoc:aggregate
9+
10+
# Copy Javadoc to manual directory
11+
mkdir manual/api || true
12+
cp -r target/site/apidocs/* manual/api
13+
14+
# Build manual with API references
15+
mkdocs build # or `mkdocs serve` to preview
16+
17+
# Remove Javadoc from manual directory
18+
rm -rf manual/api

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: Java Driver for Apache Cassandra
22
site_description: Java Driver for Apache Cassandra® Documentation
3-
site_url: https://github.com/apache/cassandra-java-driver/manual/
3+
site_url: https://github.com/apache/cassandra-java-driver
44
repo_url: https://github.com/apache/cassandra-java-driver
55
repo_name: apache/cassandra-java-driver
66

@@ -100,6 +100,7 @@ nav:
100100
- Request Execution: developer/request_execution/README.md
101101
- Admin: developer/admin/README.md
102102
- OSGi: osgi/README.md
103+
- API References: api/index.html
103104
- FAQ: faq-README.md
104105
- Changelog: changelog-README.md
105106
- Upgrade Guide: upgrade-README.md

0 commit comments

Comments
 (0)