Robolectric

This repository is the source for the docs that live at robolectric.org.

Contributing

Make sure you are in the master branch before making changes. This is the default branch so git should put you there automatically.

Before submitting a pull request, view the docs locally to check that the content and layout are correct. The docs are built using jekyll.

Assuming you don't already have Bundler installed, you will first need to do:

gem install bundler

The above command may require sudo.

Then run:

bundle install
bundle exec jekyll server

This will build the docs and make them available at localhost:4000. Once your pull request is accepted, the docs will be automatically built and pushed to the web by GitHub.

Javadocs

When Robolectric is released, the source/javadocs directory needs to be updated. They can be generated with:

./gradlew aggregateJavadocs