Skip to content

Commit 0eace8f

Browse files
cjbrooks12cjbrooks12
committed
Moves Orchid into its own module, sets it up with basic config for multi-module Javadoc
1 parent e35c2c6 commit 0eace8f

File tree

14 files changed

+266
-252
lines changed

14 files changed

+266
-252
lines changed

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,7 @@ fabric.properties
9191
.idea/**/markdown-navigator/
9292

9393
# End of https://www.gitignore.io/api/intellij
94-
/build/
94+
build/
9595
/.idea/
96+
97+
.gradle/

‎build.gradle‎

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ plugins{
77
id 'maven'
88
id 'com.github.johnrengelman.shadow' version '5.2.0'
99
id 'net.kyori.blossom' version '1.1.0'
10-
id "com.eden.orchidPlugin" version "0.21.0"
1110
}
1211

1312
def ver = new Version(major: 5, minor: 2, revision: 3)
@@ -17,8 +16,7 @@ allprojects {
1716
apply plugin: 'maven-publish'
1817
apply plugin: 'java-library'
1918
apply plugin: 'com.github.johnrengelman.shadow'
20-
apply plugin: 'com.eden.orchidPlugin'
21-
19+
2220
group = "org.botblock"
2321
version = "$ver"
2422

@@ -31,15 +29,6 @@ allprojects {
3129
api group: 'org.json', name: 'json', version: '20200518'
3230
api group: 'com.github.ben-manes.caffeine', name: 'caffeine', version: '2.8.0'
3331
api group: 'com.google.code.findbugs', name: 'jsr305', version: '3.0.2'
34-
35-
orchidCompile("io.github.javaeden.orchid:OrchidCore:0.21.0")
36-
orchidCompile("io.github.javaeden.orchid:OrchidBsDoc:0.21.0")
37-
orchidRuntime("io.github.javaeden.orchid:OrchidJavadoc:0.21.0")
38-
}
39-
40-
orchid{
41-
baseUrl = "https://localhost:8080"
42-
version = "$ver"
4332
}
4433
}
4534

‎core/README.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
---
3+
4+
This is the core module used across all other modules.
5+
6+
When using either of the other modules is this one here required to be installed too.
7+
8+
# Installation
9+
10+
## Maven
11+
12+
```xml
13+
<repositories>
14+
<repository>
15+
<id>jcenter</id>
16+
<name>jcenter-bintray</name>
17+
<url>https://jcenter.binrtray.com</url>
18+
</repository>
19+
</repositories>
20+
21+
<dependencies>
22+
<dependency>
23+
<groupId>org.botblock</groupId>
24+
<artifactId>JavaBotBlockAPI-core</artifactId>
25+
<version>{{site.version}}</version>
26+
</dependency>
27+
</dependencies>
28+
```
29+
30+
31+
## Gradle (Recommendet)
32+
33+
```groovy
34+
repositories{
35+
jcenter()
36+
}
37+
38+
dependencies{
39+
compile 'org.botblock:JavaBotBlockAPI-core:{{site.version}}'
40+
}
41+
```
42+
43+
## Manual
44+
We do not recommend using jar files directly and instead use one of the above dependency management systems.
45+
46+
If you still want to do it manually, or can't use one of the other option, head over to the
47+
<a target="_blank" href="https://github.com/botblock/JavaBotBlockAPI/releases/latest">GitHub releases page</a> or to
48+
the <a target="_blank" href="https://bintray.com/beta/#/andre601/maven/JavaBotBlockAPI?tab=overview">Bintray release page</a>
49+
and download the jar files from there.
50+
51+
Note that you will not receive any support when using this method.

‎core/src/main/java/org/botblock/javabotblockapi/core/package-info.java‎

Lines changed: 0 additions & 65 deletions
This file was deleted.

‎docs/build.gradle‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
plugins {
2+
id "com.eden.orchidPlugin" version "0.21.1"
3+
}
4+
5+
group = "org.botblock"
6+
version = rootProject.version
7+
8+
repositories {
9+
jcenter()
10+
maven { url = "https://kotlin.bintray.com/kotlinx/" }
11+
}
12+
13+
dependencies {
14+
orchidRuntime("io.github.javaeden.orchid:OrchidCore:0.21.1")
15+
orchidRuntime("io.github.javaeden.orchid:OrchidDocs:0.21.1")
16+
orchidRuntime("io.github.javaeden.orchid:OrchidBsDoc:0.21.1")
17+
orchidRuntime("io.github.javaeden.orchid:OrchidJavadoc:0.21.1")
18+
orchidRuntime("io.github.javaeden.orchid:OrchidPluginDocs:0.21.1")
19+
}

‎docs/src/orchid/resources/config.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
site:
2+
theme: BsDoc
3+
baseUrl: 'https://docs.botblock.org/JavaBotBlockAPI/'
4+
5+
theme:
6+
primaryColor: '#2C2F33'
7+
menu:
8+
- type: 'sourcedocModules'
9+
moduleType: 'javadoc'
10+
asSubmenu: true
11+
submenuTitle: 'API Docs'
12+
13+
javadoc:
14+
modules:
15+
- name: 'Core'
16+
slug: 'javabotblockapi-core'
17+
sourceDirs: ['../../../../core/src/main/java']
18+
- name: 'Request'
19+
slug: 'javabotblockapi-request'
20+
sourceDirs: ['../../../../request-module/src/main/java']
21+
- name: 'JDA'
22+
slug: 'javabotblockapi-jda'
23+
sourceDirs: ['../../../../jda-module/src/main/java']
24+
relatedModules: ['Core', 'Request']
25+
pages:
26+
menu:
27+
- type: 'sourcedocPageLinks'
28+
moduleType: 'kotlindoc'
29+
itemTitleType: 'SIGNATURE'
30+
includeItems: true
31+
32+
- type: 'sourcedocPages'
33+
moduleType: 'javadoc'
34+
moduleName: 'Core'
35+
node: 'classes'
36+
asSubmenu: true
37+
submenuTitle: 'Core Classes'
38+
- type: 'sourcedocPages'
39+
moduleType: 'javadoc'
40+
moduleName: 'Core'
41+
node: 'packages'
42+
asSubmenu: true
43+
submenuTitle: 'Core Packages'
44+
45+
- type: 'sourcedocPages'
46+
moduleType: 'javadoc'
47+
moduleName: 'Request'
48+
node: 'classes'
49+
asSubmenu: true
50+
submenuTitle: 'Request Classes'
51+
- type: 'sourcedocPages'
52+
moduleType: 'javadoc'
53+
moduleName: 'Request'
54+
node: 'packages'
55+
asSubmenu: true
56+
submenuTitle: 'Request Packages'
57+
58+
- type: 'sourcedocPages'
59+
moduleType: 'javadoc'
60+
moduleName: 'JDA'
61+
node: 'classes'
62+
asSubmenu: true
63+
submenuTitle: 'JDA Classes'
64+
- type: 'sourcedocPages'
65+
moduleType: 'javadoc'
66+
moduleName: 'JDA'
67+
node: 'packages'
68+
asSubmenu: true
69+
submenuTitle: 'JDA Packages'

‎docs/src/orchid/resources/homepage.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
components:
3+
- type: 'readme'
4+
---

‎jda-module/README.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
---
3+
4+
This is the jda-module, which is used to provide support for the Java Discord API (JDA).
5+
6+
It depends on both the {{ anchor('Core Module', 'Core') }} and the {{ anchor('Request Module', 'Request') }} and won't work without it.
7+
8+
## Installation
9+
10+
## Maven
11+
12+
```xml
13+
<repositories>
14+
<repository>
15+
<id>jcenter</id>
16+
<name>jcenter-bintray</name>
17+
<url>https://jcenter.binrtray.com</url>
18+
</repository>
19+
</repositories>
20+
<dependencies>
21+
<dependency>
22+
<groupId>org.botblock</groupId>
23+
<artifactId>JavaBotBlockAPI-core</artifactId>
24+
<version>{{site.version}}</version>
25+
</dependency>
26+
<dependency>
27+
<groupId>org.botblock</groupId>
28+
<artifactId>JavaBotBlockAPI-request-module</artifactId>
29+
<version>{{site.version}}</version>
30+
</dependency>
31+
<dependency>
32+
<groupId>org.botblock</groupId>
33+
<artifactId>JavaBotBlockAPI-jda-module</artifactId>
34+
<version>{{site.version}}</version>
35+
</dependency>
36+
</dependencies>
37+
```
38+
39+
40+
## Gradle (Recommendet)
41+
42+
```groovy
43+
repositories{
44+
jcenter()
45+
}
46+
dependencies{
47+
compile 'org.botblock:JavaBotBlockAPI-core:{{site.version}}'
48+
compile 'org.botblock:JavaBotBlockAPI-request-module:{{site.version}}'
49+
compile 'org.botblock:JavaBotBlockAPI-jda-module:{{site.version}}'
50+
}
51+
```
52+
53+
## Manual
54+
We do not recommend using jar files directly and instead use one of the above dependency management systems.
55+
56+
If you still want to do it manually, or can't use one of the other option, head over to the
57+
<a target="_blank" href="https://github.com/botblock/JavaBotBlockAPI/releases/latest">GitHub releases page</a> or to
58+
the <a target="_blank" href="https://bintray.com/beta/#/andre601/maven/JavaBotBlockAPI?tab=overview">Bintray release page</a>
59+
and download the jar files from there.
60+
61+
Note that you will not receive any support when using this method.

‎jda-module/src/main/java/org/botblock/javabotblockapi/jda/package-info.java‎

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)