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

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 --incremental

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.

If you want to update Jekyll's dependencies, you can run:

bundle update

When Robolectric is released, the source/javadocs directory needs to be updated. We can get latest steps to generate Javadocs at Robolectric Wiki's release part.