diff options
Diffstat (limited to 'subprojects')
-rw-r--r-- | subprojects/docs/build.gradle.kts | 51 | ||||
-rw-r--r-- | subprojects/docs/docusaurus.config.ts | 2 | ||||
-rw-r--r-- | subprojects/docs/src/docs-api/javadoc.md | 35 |
3 files changed, 86 insertions, 2 deletions
diff --git a/subprojects/docs/build.gradle.kts b/subprojects/docs/build.gradle.kts index 9226ffe0..b49d9797 100644 --- a/subprojects/docs/build.gradle.kts +++ b/subprojects/docs/build.gradle.kts | |||
@@ -16,10 +16,40 @@ frontend { | |||
16 | assembleScript.set("run build") | 16 | assembleScript.set("run build") |
17 | } | 17 | } |
18 | 18 | ||
19 | val javadocs: Configuration by configurations.creating { | ||
20 | isCanBeConsumed = false | ||
21 | isCanBeResolved = true | ||
22 | } | ||
23 | |||
24 | dependencies { | ||
25 | javadocs(project(":refinery-generator", "javadocElements")) | ||
26 | javadocs(project(":refinery-generator-cli", "javadocElements")) | ||
27 | javadocs(project(":refinery-interpreter", "javadocElements")) | ||
28 | javadocs(project(":refinery-interpreter-localsearch", "javadocElements")) | ||
29 | javadocs(project(":refinery-interpreter-rete", "javadocElements")) | ||
30 | javadocs(project(":refinery-interpreter-rete-recipes", "javadocElements")) | ||
31 | javadocs(project(":refinery-language", "javadocElements")) | ||
32 | javadocs(project(":refinery-language-ide", "javadocElements")) | ||
33 | javadocs(project(":refinery-language-model", "javadocElements")) | ||
34 | javadocs(project(":refinery-language-semantics", "javadocElements")) | ||
35 | javadocs(project(":refinery-language-web", "javadocElements")) | ||
36 | javadocs(project(":refinery-logic", "javadocElements")) | ||
37 | javadocs(project(":refinery-store", "javadocElements")) | ||
38 | javadocs(project(":refinery-store-dse", "javadocElements")) | ||
39 | javadocs(project(":refinery-store-dse-visualization", "javadocElements")) | ||
40 | javadocs(project(":refinery-store-query", "javadocElements")) | ||
41 | javadocs(project(":refinery-store-query-interpreter", "javadocElements")) | ||
42 | javadocs(project(":refinery-store-reasoning", "javadocElements")) | ||
43 | javadocs(project(":refinery-store-reasoning-scope", "javadocElements")) | ||
44 | javadocs(project(":refinery-store-reasoning-smt", "javadocElements")) | ||
45 | } | ||
46 | |||
19 | val srcDir = "src" | 47 | val srcDir = "src" |
20 | 48 | ||
21 | val docusaurusOutputDir = layout.buildDirectory.dir("docusaurus") | 49 | val docusaurusOutputDir = layout.buildDirectory.dir("docusaurus") |
22 | 50 | ||
51 | val javadocsDir = layout.buildDirectory.dir("javadocs/api/javadoc") | ||
52 | |||
23 | val configFiles: FileCollection = files( | 53 | val configFiles: FileCollection = files( |
24 | rootProject.file("yarn.lock"), | 54 | rootProject.file("yarn.lock"), |
25 | rootProject.file("package.json"), | 55 | rootProject.file("package.json"), |
@@ -36,8 +66,27 @@ val lintConfigFiles: FileCollection = configFiles + files( | |||
36 | ) | 66 | ) |
37 | 67 | ||
38 | tasks { | 68 | tasks { |
69 | val extractJavadocs by registering { | ||
70 | dependsOn(javadocs) | ||
71 | outputs.dir(javadocsDir) | ||
72 | doFirst { | ||
73 | delete(javadocsDir) | ||
74 | } | ||
75 | doLast { | ||
76 | javadocs.resolvedConfiguration.resolvedArtifacts.forEach { artifact -> | ||
77 | copy { | ||
78 | from(zipTree(artifact.file)) | ||
79 | into(javadocsDir.map { root -> root.dir(artifact.moduleVersion.id.name) }) | ||
80 | } | ||
81 | } | ||
82 | } | ||
83 | } | ||
84 | |||
39 | assembleFrontend { | 85 | assembleFrontend { |
40 | inputs.dir("src") | 86 | dependsOn(extractJavadocs) |
87 | inputs.dir(srcDir) | ||
88 | inputs.dir("static") | ||
89 | inputs.dir(javadocsDir) | ||
41 | inputs.files(configFiles) | 90 | inputs.files(configFiles) |
42 | outputs.dir(docusaurusOutputDir) | 91 | outputs.dir(docusaurusOutputDir) |
43 | } | 92 | } |
diff --git a/subprojects/docs/docusaurus.config.ts b/subprojects/docs/docusaurus.config.ts index 663c4876..47bf605e 100644 --- a/subprojects/docs/docusaurus.config.ts +++ b/subprojects/docs/docusaurus.config.ts | |||
@@ -26,7 +26,7 @@ export default { | |||
26 | baseUrl: '/', | 26 | baseUrl: '/', |
27 | baseUrlIssueBanner: false, | 27 | baseUrlIssueBanner: false, |
28 | trailingSlash: true, | 28 | trailingSlash: true, |
29 | staticDirectories: ['static'], | 29 | staticDirectories: ['static', 'build/javadocs'], |
30 | plugins: [ | 30 | plugins: [ |
31 | [ | 31 | [ |
32 | '@docusaurus/plugin-content-docs', | 32 | '@docusaurus/plugin-content-docs', |
diff --git a/subprojects/docs/src/docs-api/javadoc.md b/subprojects/docs/src/docs-api/javadoc.md index 09b3e4f7..7e39b9b9 100644 --- a/subprojects/docs/src/docs-api/javadoc.md +++ b/subprojects/docs/src/docs-api/javadoc.md | |||
@@ -1,7 +1,42 @@ | |||
1 | --- | 1 | --- |
2 | SPDX-FileCopyrightText: 2024 The Refinery Authors | 2 | SPDX-FileCopyrightText: 2024 The Refinery Authors |
3 | SPDX-License-Identifier: EPL-2.0 | 3 | SPDX-License-Identifier: EPL-2.0 |
4 | description: API documentation for Refinery components automatically generated by Javadoc | ||
4 | sidebar_position: 999 | 5 | sidebar_position: 999 |
5 | --- | 6 | --- |
6 | 7 | ||
7 | # Javadoc | 8 | # Javadoc |
9 | |||
10 | Here you can find API documentation for Refinery components automatically generated by Javadoc. We recommend reading the [Programming guide](/api) first to understand how to use these components. | ||
11 | |||
12 | # Refinery | ||
13 | |||
14 | * [`tools.refinery:refinery-generator`](pathname://refinery-generator) | ||
15 | * [`tools.refinery:refinery-generator-cli`](pathname://refinery-generator-cli) | ||
16 | * [`tools.refinery:refinery-language`](pathname://refinery-language) | ||
17 | * [`tools.refinery:refinery-language-ide`](pathname://refinery-language-ide) | ||
18 | * [`tools.refinery:refinery-language-model`](pathname://refinery-language-model) | ||
19 | * [`tools.refinery:refinery-language-semantics`](pathname://refinery-language-semantics) | ||
20 | * [`tools.refinery:refinery-language-web`](pathname://refinery-language-web) | ||
21 | * [`tools.refinery:refinery-logic`](pathname://refinery-logic) | ||
22 | * [`tools.refinery:refinery-store`](pathname://refinery-store) | ||
23 | * [`tools.refinery:refinery-store-dse`](pathname://refinery-store-dse) | ||
24 | * [`tools.refinery:refinery-store-dse-visualization`](pathname://refinery-store-dse-visualization) | ||
25 | * [`tools.refinery:refinery-store-query`](pathname://refinery-store-query) | ||
26 | * [`tools.refinery:refinery-store-query-interpreter`](pathname://refinery-store-query-interpreter) | ||
27 | * [`tools.refinery:refinery-store-reasoning`](pathname://refinery-store-reasoning) | ||
28 | * [`tools.refinery:refinery-store-reasoning-scope`](pathname://refinery-store-reasoning-scope) | ||
29 | * [`tools.refinery:refinery-store-reasoning-smt`](pathname://refinery-store-reasoning-smt) | ||
30 | |||
31 | # Interpreter | ||
32 | |||
33 | :::note | ||
34 | |||
35 | The _Refinery Interpreter_ is modified version of [VIATRA™](https://eclipse.dev/viatra/) specifically for use in Refinery. If you're interested in learning about [VIATRA™](https://eclipse.dev/viatra/), we recommend the [VIATRA™ documentation](https://eclipse.dev/viatra/documentation/index.html) and [source code](https://github.com/eclipse-viatra/org.eclipse.viatra) instead. Eclipse®, VIATRA™ and ‘Eclipse VIATRA™’ are trademarks of Eclipse Foundation, Inc. | ||
36 | |||
37 | ::: | ||
38 | |||
39 | * [`tools.refinery.interpreter:refinery-interpreter`](pathname://refinery-interpreter) | ||
40 | * [`tools.refinery.interpreter:refinery-interpreter-localsearch`](pathname://refinery-interpreter-localsearch) | ||
41 | * [`tools.refinery.interpreter:refinery-interpreter-rete`](pathname://refinery-interpreter-rete) | ||
42 | * [`tools.refinery.interpreter:refinery-interpreter-rete-recipes`](pathname://refinery-interpreter-rete-recipes) | ||