You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository is the source for the docs that live at [robolectric.org](http://robolectric.org).
6
6
7
7
## Contributing
8
8
9
-
Make sure you are in the `source` branch before making changes. This is the default branch so git should put you there automatically.
9
+
Make sure you are in the `master` branch before making changes. This is the default branch so git should put you there automatically.
10
10
11
-
Before submitting a pull request, view the docs locally to check that the content and layout are correct. The docs are built using [middleman](https://github.com/middleman/middleman).
11
+
Before submitting a pull request, view the docs locally to check that the content and layout are correct. The docs are built using [jekyll](https://jekyllrb.com/).
12
12
13
13
Assuming you don't already have [Bundler](http://bundler.io/) installed, you will first need to do:
14
14
@@ -19,20 +19,13 @@ The above command may require `sudo`.
19
19
Then run:
20
20
21
21
bundle install
22
-
bundle exec middleman server
22
+
bundle exec jekyll server
23
23
24
-
This will build the docs and make them available at [localhost:4567](http://localhost:4567). Once
25
-
your pull request is accepted, the docs will be automatically built and pushed to the web by
26
-
Travis CI.
24
+
This will build the docs and make them available at [localhost:4000](http://localhost:4000). Once
25
+
your pull request is accepted, the docs will be automatically built and pushed to the web by GitHub.
27
26
28
27
## Javadocs
29
28
30
-
When Robolectric is released, the `source/javadocs` directory needs to be updated. This can be done by grabbing the javadocs that were pushed to [Maven Central](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.robolectric%22%20AND%20a%3A%22robolectric%22) and unjarring them into that directory.
31
-
32
-
## Gory Details: How These Docs Get Published
33
-
34
-
This repository has 2 branches: `source` and `master`. The former is a middleman project that can generate the latter. With every commit that is made to the `source` branch, Travis CI runs middleman and deploys the results back to the `master` branch. It does this by using an OAUTH token belonging to the robolectric-travis-bot user, who only has permission to commit and push to this repository.
35
-
36
-
37
-
29
+
When Robolectric is released, the `source/javadocs` directory needs to be updated. They can be generated with:
0 commit comments