Custom cinder build

Author: akshaisarma

README.md

@@ -2,10 +2,34 @@
 
 This hosts the documentation source and examples for [Bullet](https://github.com/yahoo/bullet-storm).
 
+The built documentation can be accessed [here](https://yahoo.github.io/bullet-docs).
+
+## Building the documentation
+
 You need [mkdocs](http://www.mkdocs.org/#installation) installed to build the documentation.
 
+This also uses the mkdocs theme : [Cinder](http://sourcefoundry.org/cinder/).
+
+Since Cinder has not been upgraded in a while, you will need to bring in changes in this [PR](https://github.com/chrissimpkins/cinder/pull/26) of Cinder found here: [twardoch/clinker-mktheme](https://github.com/twardoch/clinker-mktheme/tree/2016-12-22)
+
+You will need Python installed.
+
+```bash
+sudo pip install virtualenv
+virtualenv mkdocs
+source mkdocs/bin/activate
+pip install mkdocs-cinder
+pip install git+git://github.com/twardoch/clinker-mktheme.git@2016-12-22 --upgrade
+git clone git@github.com:yahoo/bullet-docs.git
+cd bullet-docs
+mkdocs build
+```
+## Building the examples
+
 You will need [Maven 3](https://maven.apache.org/install.html) and [JDK 8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) installed to build the examples.
 
-The built documentation can be accessed [here](https://yahoo.github.io/bullet-docs). You can quickly jump into setting up a local Bullet instance by following the [Quick Start here](https://yahoo.github.io/bullet-docs#quick-start).
+```bash
+cd bullet-docs/examples/storm && mvn package
+```
 
 Code licensed under the Apache 2 license. See LICENSE file for terms.

docs/css/extra.css

@@ -16,3 +16,11 @@
 .admonition-title {
   font-weight: bold;
 }
+
+.bs-sidebar .nav .nav > li > a {
+  font-size: 100%;
+}
+
+img {
+  max-width: none;
+}

mkdocs.yml

@@ -27,6 +27,9 @@ pages:
 markdown_extensions:
     - admonition
 
+extra:
+  collapse_toc: true
+
 extra_css:
   - css/extra.css