Documentation updates

[k...@networkedplanet.com]

Hi all,

As part of moving away from the use of commercial applications in the BrightstarDB build, I've recently moved all the documentation over to use Sphinx. Sphinx (http://sphinx-doc.org/) is a Python-based documentation tool that uses reStructuredText (http://docutils.sourceforge.net/rst.html) as the markup language. The main reason for choosing Sphinx over doxygen and other open-source documentation tools is that it allows us to use the nice folks at readthedocs.org's infrastructure. 

So, you will now find the latest BrightstarDB documentation online at https://brightstardb.readthedocs.org/en/latest/ in both HTML and PDF flavours.

The API documentation will still be generated through Sandcastle for the time being. If I can find a place that would do the same as readthedocs.org for Sandcastle I would be a happy man :-) In the short-term however, my plan is to ship the .CHM file from Sandcastle with the installer and to host the API documentation for each *release* build on http://brightstardb.com/, but to keep the other docs on readthedocs.org (with a link across from brightstardb.com). This does mean that to get the latest API docs you have to build them yourself from source, but Sandcastle is pretty easy to install and run.

This is a bit of an experiment - I've not used Sphinx or readthedocs.org before (except as a reader of documentation hosted there), if you have any thoughts/issues please let me know!

Cheers

Kal