Docs updates (#599)

- Updated docs GH workflow to build and publish javadoc alongside of
docs directory. This would make the docs available at
https://langchain4j.github.io/langchain4j and javadoc at
https://langchain4j.github.io/langchain4j/apidocs/index.html
- Updated javadoc build command in docs GH workflow to do a full project
build (that includes all modules and no exclusions).
- Updated javadoc build in docs GH workflow to run with Java 21 version.

This is in reference to
https://github.com/langchain4j/langchain4j/discussions/596

---------

Co-authored-by: Lize Raes <49833622+LizeRaes@users.noreply.github.com>
This commit is contained in:
Amith Koujalgi 2024-02-06 15:43:41 +05:30 committed by GitHub
parent 34865af810
commit 31f0da6e94
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 31 additions and 4 deletions

View File

@ -23,12 +23,25 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Use Node.js
- name: Set up JDK 21
uses: actions/setup-java@v3
with:
java-version: '21'
distribution: 'temurin'
cache: 'maven'
- name: Generate Javadoc
run: mvn javadoc:aggregate -DskipTests
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: '20.x'
- run: cd docs && npm ci
- run: cd docs && npm run build
- run: cp -R target/site/apidocs docs/build/
- name: Setup Pages
uses: actions/configure-pages@v3

5
docs/build.sh Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
npm ci
npm run build

View File

@ -86,7 +86,11 @@ const config = {
},
{to: '/docs/tutorials', label: 'Tutorials', position: 'left'},
{to: '/docs/category/integrations', label: 'Integrations', position: 'left'},
{to: 'https://lizeraes.github.io/langchain4j/apidocs/', label: 'Javadoc', position: 'left'},
{
href: 'https://langchain4j.github.io/langchain4j/apidocs/index.html',
label: 'Javadoc',
position: 'left'
},
{to: '/blog', label: 'Blog', position: 'left'},
{
href: 'https://github.com/langchain4j/langchain4j',
@ -119,8 +123,8 @@ const config = {
href: 'https://discord.com/invite/JzTFvyjG6R',
},
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/langchain4j',
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/langchain4j',
},
],
},

5
docs/start.sh Executable file
View File

@ -0,0 +1,5 @@
#!/usr/bin/env bash
npm ci
npm run start