Build and publish Javadoc to GitHub Pages using Travis CI

This commit is contained in:
Filip Š 2020-07-05 20:25:46 +02:00
parent 559d8f3972
commit dc61df7b39
2 changed files with 15 additions and 1 deletions

View file

@ -14,4 +14,16 @@ jdk:
- oraclejdk8
script:
- ./gradlew check --info -S --parallel
- ./gradlew check --info -S --parallel
defore_deploy:
- ./gradlew javadoc
deploy:
provider: pages
skip_cleanup: true
keep_history: true
on:
branch: master
github_token: $GITHUB_TOKEN
local_dir: build/docs/javadoc

View file

@ -52,6 +52,8 @@ At the heart of Brigadier, you need a `CommandDispatcher<S>`, where `<S>` is any
A command dispatcher holds a "command tree", which is a series of `CommandNode`s that represent the various possible syntax options that form a valid command.
Javadoc of Brigadier API is available on [GitHub Pages](https://mojang.github.io/brigadier/).
## Registering a new command
Before we can start parsing and dispatching commands, we need to build up our command tree. Every registration is an append operation,
so you can freely extend existing commands in a project without needing access to the source code that created them.