Sheldan/abstracto
1
0
Fork 0
mirror of https://github.com/Sheldan/abstracto.git synced 2026-03-05 07:59:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

added configuration to deploy documentation to GitHub pages when a release is happening

Browse Source 
adapted documentation configuration
This commit is contained in:
Sheldan
2020-06-03 21:52:58 +02:00
parent db8afde7ea
commit 601c4b7121
5 changed files with 43 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
abstracto-application/documentation/pom.xml
View File

@@ -44,6 +44,8 @@
<sourceDirectory>src/main/docs/asciidoc</sourceDirectory>
<sourceDocumentName>main.adoc</sourceDocumentName>
<attributes>
<revnumber>${project.version}</revnumber>
<revdate>${maven.build.timestamp}</revdate>
</attributes>
</configuration>
<executions>
@@ -56,6 +58,7 @@
<configuration>
<backend>pdf</backend>
<sourceHighlighter>coderay</sourceHighlighter>
<outputFile>documentation.pdf</outputFile>
<attributes>
<icons>font</icons>
<pagenums/>
@@ -72,6 +75,7 @@
<goal>process-asciidoc</goal>
</goals>
<configuration>
<outputFile>index.html</outputFile>
<sourceDirectory>src/main/docs/asciidoc</sourceDirectory>
<backend>html</backend>
<doctype>book</doctype>

5
abstracto-application/documentation/src/main/docs/asciidoc/main.adoc
View File

@@ -1,13 +1,14 @@
= Abstracto Discord Bot Documentation
Sheldan https://github.com/Sheldan
1.0, May 10, 2020
Sheldan https://github.com/Sheldan/abstracto
:toc:
:toclevels: 5
:sectnums:
:title-page:
:sectnumlevels: 5
:icons: font
== Description
Abstracto is a feature rich Discord bot written in Java and uses JDA as the wrapper for the Discord API.
This documentation is split into two parts: Technical documentation and user documentation.