Skip to content

Commit

Permalink
Configure stub 'pl' translation (#62)
Browse files Browse the repository at this point in the history
related: #58
  • Loading branch information
pivovarit authored Dec 6, 2024
1 parent 3111db6 commit d28fa8d
Show file tree
Hide file tree
Showing 17 changed files with 1,231 additions and 1 deletion.
30 changes: 29 additions & 1 deletion build.gradle
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import org.asciidoctor.gradle.jvm.AsciidoctorTask

buildscript {
repositories {
mavenCentral()
Expand Down Expand Up @@ -77,6 +79,32 @@ asciidoctor {
}
}

tasks.register('asciidoc_pl', AsciidoctorTask) {
group = 'documentation'
description = 'Generates documentation for the "pl" directory.'

sourceDir = file('src/docs/asciidoc/pl')
outputDir = file("$buildDir/docs/asciidoc/pl")

options backend: 'html5'

baseDirFollowsSourceDir()

attributes(
'project-version': project.version
)

sources {
include '**/*.adoc'
}

resources {
from(sourceDir) {
include 'images/**'
}
}
}

tasks.withType(Copy).configureEach {
eachFile { println it.file }
}
Expand All @@ -86,7 +114,7 @@ tasks.register('copyCNAME', Copy) {
into file(asciidoctor.outputDir.path)
}

//asciidoctor.dependsOn test
asciidoctor.dependsOn asciidoc_pl
copyCNAME.dependsOn asciidoctor
publishGhPages.dependsOn copyCNAME

Expand Down
86 changes: 86 additions & 0 deletions src/docs/asciidoc/pl/getting_started.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
== Getting started

Projects that include Vavr need to target Java 1.8 at minimum.

The .jar is available at http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22io.vavr%22%20a%3A%22vavr%22[Maven Central].

=== Gradle

[source,groovy]
[subs="attributes"]
----
dependencies {
compile "io.vavr:vavr:{project-version}"
}
----

Gradle 7+

[source,groovy]
[subs="attributes"]
----
dependencies {
implementation "io.vavr:vavr:{project-version}"
}
----

=== Maven

[source,xml]
----
<dependencies>
<dependency>
<groupId>io.vavr</groupId>
<artifactId>vavr</artifactId>
<version>0.10.5</version>
</dependency>
</dependencies>
----

=== Standalone

Because Vavr does __not__ depend on any libraries (other than the JVM) you can easily add it as standalone .jar to your classpath.

=== Snapshots

Developer versions can be found https://oss.sonatype.org/content/repositories/snapshots/io/vavr/vavr[here].

==== Gradle

Add the additional snapshot repository to your `build.gradle`:

[source,groovy]
----
repositories {
(...)
maven { url "https://oss.sonatype.org/content/repositories/snapshots" }
}
----

==== Maven

Ensure that your ``~/.m2/settings.xml`` contains the following:

[source,xml]
----
<profiles>
<profile>
<id>allow-snapshots</id>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
<repositories>
<repository>
<id>snapshots-repo</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
</profile>
</profiles>
----
Binary file added src/docs/asciidoc/pl/images/binarytree1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/binarytree2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/collections-seq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/list1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/list2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/queue1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/queue2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/vavr-collections.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/asciidoc/pl/images/vavr-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions src/docs/asciidoc/pl/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
= Vavr Dokumentacja Techniczna
Daniel Dietrich, Robert Winkler, Grzegorz Piwowarek
:toc: left
:toclevels: 3
:source-highlighter: coderay
:numbered:
:hardbreaks:
:revnumber: {project-version}
:revdate: {localdate}
:icons: font
:pagenums:

include::introduction.adoc[]

include::getting_started.adoc[]

include::usage_guide.adoc[]

include::pattern_matching.adoc[]

include::license.adoc[]
Loading

0 comments on commit d28fa8d

Please sign in to comment.