Merge remote-tracking branch 'origin/develop' into feat/17/provide-a-restful-api

PYTHON_STYLE_GUIDE.md

@@ -20,7 +20,7 @@ PEP8 says some things about docstrings, but not what to put in them or how to st
 
 PEP8 has some [maximum line length guidelines](https://www.python.org/dev/peps/pep-0008/#id17), starting with "Limit all lines to a maximum of 79 characters" but "for flowing long blocks of text with fewer structural restrictions (docstrings or comments), the line length should be limited to 72 characters."
 
-We discussed this at length, and it seems that the consensus is: try to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and BigchainDB is an open source project.)
+We discussed this at length, and it seems that the consensus is: _try_ to keep line lengths less than 79/72 characters, unless you have a special situation where longer lines would improve readability. (The basic reason is that 79/72 works for everyone, and BigchainDB is an open source project.) As a hard limit, keep all lines less than 119 characters (which is the width of GitHub code review).
 
 ### Single or Double Quotes?
 

docs/requirements.txt

@@ -1,3 +1,4 @@
 Sphinx==1.3.5
 sphinxcontrib-napoleon==0.4.4
+sphinx-rtd-theme>=0.1.9
 recommonmark

docs/source/conf.py

@@ -28,6 +28,9 @@ from recommonmark.parser import CommonMarkParser
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
+import sphinx_rtd_theme
+
+
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -119,7 +122,8 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -127,7 +131,7 @@ html_theme = 'alabaster'
 #html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".

docs/source/installing.md

@@ -27,12 +27,20 @@ If you don't already have it, then you should [install Python 3.4+](https://www.
 
 BigchainDB has some OS-level dependencies. In particular, you need to install the OS-level dependencies for the Python **cryptography** package. Instructions for installing those dependencies on your OS can be found in the [cryptography package documentation](https://cryptography.io/en/latest/installation/).
 
-On Ubuntu 14.04, we found that the following was enough (YMMV):
+On Ubuntu 14.04, we found that the following was enough:
 ```text
 $ sudo apt-get update
 $ sudo apt-get install libffi-dev g++ libssl-dev python3-dev
 ```
 
+On Fedora 23, we found that the following was enough (tested in February 2015):
+```text
+$ sudo dnf update
+$ sudo dnf install libffi-devel gcc-c++ redhat-rpm-config python3-devel openssl-devel
+```
+
+(If you're using a version of Fedora before version 22, you may have to use `yum` instead of `dnf`.)
+
 With OS-level dependencies installed, you can install BigchainDB with `pip` or from source.
 
 ### How to Install BigchainDB with `pip`

setup.py

@@ -27,6 +27,7 @@ docs_require = [
     'recommonmark>=0.4.0',
     'Sphinx>=1.3.5',
     'sphinxcontrib-napoleon>=0.4.4',
+    'sphinx-rtd-theme>=0.1.9',
 ]
 
 setup(