Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build and publish Javadoc to GitHub Pages using Travis CI #71

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 13 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,16 @@ jdk:
- oraclejdk8

script:
- ./gradlew check --info -S --parallel
- ./gradlew check --info -S --parallel

before_deploy:
- ./gradlew javadoc

deploy:
provider: pages
skip_cleanup: true
keep_history: true
on:
branch: master
github_token: $GITHUB_TOKEN
local_dir: build/docs/javadoc
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down