Skip to content

Commit d28fa8d

Browse files
authored
Configure stub 'pl' translation (#62)
related: #58
1 parent 3111db6 commit d28fa8d

17 files changed

+1231
-1
lines changed

build.gradle

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import org.asciidoctor.gradle.jvm.AsciidoctorTask
2+
13
buildscript {
24
repositories {
35
mavenCentral()
@@ -77,6 +79,32 @@ asciidoctor {
7779
}
7880
}
7981

82+
tasks.register('asciidoc_pl', AsciidoctorTask) {
83+
group = 'documentation'
84+
description = 'Generates documentation for the "pl" directory.'
85+
86+
sourceDir = file('src/docs/asciidoc/pl')
87+
outputDir = file("$buildDir/docs/asciidoc/pl")
88+
89+
options backend: 'html5'
90+
91+
baseDirFollowsSourceDir()
92+
93+
attributes(
94+
'project-version': project.version
95+
)
96+
97+
sources {
98+
include '**/*.adoc'
99+
}
100+
101+
resources {
102+
from(sourceDir) {
103+
include 'images/**'
104+
}
105+
}
106+
}
107+
80108
tasks.withType(Copy).configureEach {
81109
eachFile { println it.file }
82110
}
@@ -86,7 +114,7 @@ tasks.register('copyCNAME', Copy) {
86114
into file(asciidoctor.outputDir.path)
87115
}
88116

89-
//asciidoctor.dependsOn test
117+
asciidoctor.dependsOn asciidoc_pl
90118
copyCNAME.dependsOn asciidoctor
91119
publishGhPages.dependsOn copyCNAME
92120

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
== Getting started
2+
3+
Projects that include Vavr need to target Java 1.8 at minimum.
4+
5+
The .jar is available at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.vavr%22%20a%3A%22vavr%22[Maven Central].
6+
7+
=== Gradle
8+
9+
[source,groovy]
10+
[subs="attributes"]
11+
----
12+
dependencies {
13+
compile "io.vavr:vavr:{project-version}"
14+
}
15+
----
16+
17+
Gradle 7+
18+
19+
[source,groovy]
20+
[subs="attributes"]
21+
----
22+
dependencies {
23+
implementation "io.vavr:vavr:{project-version}"
24+
}
25+
----
26+
27+
=== Maven
28+
29+
[source,xml]
30+
----
31+
<dependencies>
32+
<dependency>
33+
<groupId>io.vavr</groupId>
34+
<artifactId>vavr</artifactId>
35+
<version>0.10.5</version>
36+
</dependency>
37+
</dependencies>
38+
----
39+
40+
=== Standalone
41+
42+
Because Vavr does __not__ depend on any libraries (other than the JVM) you can easily add it as standalone .jar to your classpath.
43+
44+
=== Snapshots
45+
46+
Developer versions can be found https://oss.sonatype.org/content/repositories/snapshots/io/vavr/vavr[here].
47+
48+
==== Gradle
49+
50+
Add the additional snapshot repository to your `build.gradle`:
51+
52+
[source,groovy]
53+
----
54+
repositories {
55+
(...)
56+
maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
57+
}
58+
----
59+
60+
==== Maven
61+
62+
Ensure that your ``~/.m2/settings.xml`` contains the following:
63+
64+
[source,xml]
65+
----
66+
<profiles>
67+
<profile>
68+
<id>allow-snapshots</id>
69+
<activation>
70+
<activeByDefault>true</activeByDefault>
71+
</activation>
72+
<repositories>
73+
<repository>
74+
<id>snapshots-repo</id>
75+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
76+
<releases>
77+
<enabled>false</enabled>
78+
</releases>
79+
<snapshots>
80+
<enabled>true</enabled>
81+
</snapshots>
82+
</repository>
83+
</repositories>
84+
</profile>
85+
</profiles>
86+
----
6.58 KB
Loading
10 KB
Loading
12.2 KB
Loading
Loading

src/docs/asciidoc/pl/images/list1.png

2.75 KB
Loading

src/docs/asciidoc/pl/images/list2.png

3.44 KB
Loading
4.84 KB
Loading
3.12 KB
Loading
14.4 KB
Loading
75.8 KB
Loading

src/docs/asciidoc/pl/index.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
= Vavr Dokumentacja Techniczna
2+
Daniel Dietrich, Robert Winkler, Grzegorz Piwowarek
3+
:toc: left
4+
:toclevels: 3
5+
:source-highlighter: coderay
6+
:numbered:
7+
:hardbreaks:
8+
:revnumber: {project-version}
9+
:revdate: {localdate}
10+
:icons: font
11+
:pagenums:
12+
13+
include::introduction.adoc[]
14+
15+
include::getting_started.adoc[]
16+
17+
include::usage_guide.adoc[]
18+
19+
include::pattern_matching.adoc[]
20+
21+
include::license.adoc[]

0 commit comments

Comments
 (0)