Documentation Updates

AO-StreetArt · Jun 24, 2017 · 67a3ff5 · 67a3ff5
1 parent f3e8283
commit 67a3ff5
Show file tree

Hide file tree

Showing 212 changed files with 1,548 additions and 391 deletions.
diff --git a/Doxyfile b/Doxyfile
@@ -1,7 +1,7 @@
 PROJECT_NAME     = AoSharedServiceLibrary
 OUTPUT_DIRECTORY = docs/html
 WARNINGS         = YES
-INPUT            = aossl/commandline/include aossl/consul/include aossl/http/client/include aossl/http/server/include aossl/logging/include aossl/properties/include aossl/redis/include aossl/uuid/include aossl/zmq/include aossl/neo4j/include aossl/mongo/include docs/main_page.txt
+INPUT            = aossl/commandline/include aossl/consul/include aossl/http/client/include aossl/http/server/include aossl/logging/include aossl/properties/include aossl/redis/include aossl/uuid/include aossl/zmq/include aossl/neo4j/include aossl/mongo/include docs/pages/main_page.txt docs/pages/quickstart.txt docs/pages/compilation.txt docs/pages/dependencies.txt docs/pages/tests.txt docs/pages/use.txt
 FILE_PATTERNS    = factory_*.h *_interface.h *.txt
 INCLUDE_PATH     = aossl
 SEARCHENGINE     = NO
diff --git a/README.md b/README.md
@@ -32,22 +32,8 @@ While designed with a Microservice architecture in mind, AOSSL also seeks to mai
 * Support for Ubuntu 14.04, Ubuntu 16.04, Debian 7, Debian 8, CentOS 7, RHEL 7
 * Easy to construct Docker Images with templates
 
-#### Backwards Compatibility
-Starting from the release of v1.0, backwards compatibility with future versions is guaranteed up to v2.0, provided users code to the interfaces (found in lib/include/factory) rather than the implementation files.  Examples may be found in the 'Use' section of the documentation.
-
-Any interface breaking changes within the next major version will be clearly documented with the release notes.
-
-In order to use the respective interfaces, you should have an active [Consul](https://www.consul.io/) Agent, as well as servers of [Neo4j](https://neo4j.com/), [Redis](http://redis.io/), and/or [Mongo](https://www.mongodb.com) to connect to.
-
-Full API Documentation is available via doxygen, and the latest execution is stored in the docs/html folder.
-
-## Table of Contents
-
-* [Quickstart](https://github.com/AO-StreetArt/AOSharedServiceLibrary/tree/master/docs/quickstart)
-* [Use](https://github.com/AO-StreetArt/AOSharedServiceLibrary/tree/master/docs/use)
-* [Dependency Resolution](https://github.com/AO-StreetArt/AOSharedServiceLibrary/tree/master/docs/deps)
-* [Tests](https://github.com/AO-StreetArt/AOSharedServiceLibrary/tree/master/docs/tests)
-* [Building Documentation](https://github.com/AO-StreetArt/AOSharedServiceLibrary/tree/master/docs)
+## Documentation
+Check out online documentation of the latest version at [ReadTheDocs](http://aosharedservicelibrary.readthedocs.io/en/latest/index.html).
 
 ## Contributing
 

diff --git a/docs/comp/README.md b/docs/comp/README.md
diff --git a/docs/deps/README.md b/docs/deps/README.md
diff --git a/docs/html/html/annotated.html b/docs/html/html/annotated.html
diff --git a/docs/html/html/classCommandLineInterface-members.html b/docs/html/html/classCommandLineInterface-members.html
diff --git a/docs/html/html/classCommandLineInterface.html b/docs/html/html/classCommandLineInterface.html
diff --git a/docs/html/html/classCommandLineInterpreterFactory-members.html b/docs/html/html/classCommandLineInterpreterFactory-members.html
diff --git a/docs/html/html/classCommandLineInterpreterFactory.html b/docs/html/html/classCommandLineInterpreterFactory.html
diff --git a/docs/html/html/classConsulComponentFactory-members.html b/docs/html/html/classConsulComponentFactory-members.html
diff --git a/docs/html/html/classConsulComponentFactory.html b/docs/html/html/classConsulComponentFactory.html
diff --git a/docs/html/html/classConsulInterface-members.html b/docs/html/html/classConsulInterface-members.html
diff --git a/docs/html/html/classConsulInterface.html b/docs/html/html/classConsulInterface.html
diff --git a/docs/html/html/classDbListInterface-members.html b/docs/html/html/classDbListInterface-members.html
diff --git a/docs/html/html/classDbListInterface.html b/docs/html/html/classDbListInterface.html
diff --git a/docs/html/html/classDbMapInterface-members.html b/docs/html/html/classDbMapInterface-members.html
diff --git a/docs/html/html/classDbMapInterface.html b/docs/html/html/classDbMapInterface.html
diff --git a/docs/html/html/classDbObjectInterface-members.html b/docs/html/html/classDbObjectInterface-members.html
diff --git a/docs/html/html/classDbObjectInterface.html b/docs/html/html/classDbObjectInterface.html
diff --git a/docs/html/html/classHttpClientFactory-members.html b/docs/html/html/classHttpClientFactory-members.html
diff --git a/docs/html/html/classHttpClientFactory.html b/docs/html/html/classHttpClientFactory.html
diff --git a/docs/html/html/classHttpInterface-members.html b/docs/html/html/classHttpInterface-members.html
diff --git a/docs/html/html/classHttpInterface.html b/docs/html/html/classHttpInterface.html
diff --git a/docs/html/html/classHttpServerFactory-members.html b/docs/html/html/classHttpServerFactory-members.html
diff --git a/docs/html/html/classHttpServerFactory.html b/docs/html/html/classHttpServerFactory.html
diff --git a/docs/html/html/classHttpServerInterface-members.html b/docs/html/html/classHttpServerInterface-members.html
diff --git a/docs/html/html/classHttpServerInterface.html b/docs/html/html/classHttpServerInterface.html
diff --git a/docs/html/html/classLoggingCategoryInterface-members.html b/docs/html/html/classLoggingCategoryInterface-members.html
diff --git a/docs/html/html/classLoggingCategoryInterface.html b/docs/html/html/classLoggingCategoryInterface.html
diff --git a/docs/html/html/classLoggingComponentFactory-members.html b/docs/html/html/classLoggingComponentFactory-members.html
diff --git a/docs/html/html/classLoggingComponentFactory.html b/docs/html/html/classLoggingComponentFactory.html
diff --git a/docs/html/html/classLoggingInterface-members.html b/docs/html/html/classLoggingInterface-members.html
diff --git a/docs/html/html/classLoggingInterface.html b/docs/html/html/classLoggingInterface.html
diff --git a/docs/html/html/classMongoComponentFactory-members.html b/docs/html/html/classMongoComponentFactory-members.html
diff --git a/docs/html/html/classMongoComponentFactory.html b/docs/html/html/classMongoComponentFactory.html
diff --git a/docs/html/html/classMongoInterface-members.html b/docs/html/html/classMongoInterface-members.html