[documentation] first sphinx build, preparing for readthedocs (splint…

…ered-reality#81)

Has the appropriate mocks, sans py_trees since Mocks wont work as parent classes with autodoc.

.gitignore

@@ -14,4 +14,5 @@ py_trees*.tar.gz
 
 # Generated files (when debugging)
 py_trees_ros/resources/*.py
+html
 

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# read-the-docs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+  fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# [], all, or - epub, - pdf
+formats: []
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.6
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

Makefile

@@ -1,2 +1,7 @@
 docs:
-	sphinx-build -b html doc doc/html
+	sphinx-build -v -b html doc html
+
+clean:
+	rm -rf build html
+
+.PHONY: docs clean

doc/.gitignore

@@ -1,5 +1,2 @@
-.build
-dist
-html
-manifest.yaml
+build
 

doc/source/about.rst → doc/about.rst

@@ -5,11 +5,11 @@ ROS Py Trees extends the `py_trees`_ package with wrappers, patterns
 and debugging tools for use in ROS.
 
 If you are new to behaviour trees, start with the
-:ref:`py_trees documentation <pt:introduction-section>`, browse
-through a few of the readings and try the demos contained therein.
+:ref:`py_trees documentation <py_trees:introduction-section>`,
+browse through a few of the readings and try the demos contained therein.
 
-The documentation here includes the module level api documentation and
-instructions for the command line utilities. 
+The documentation in this package includes the module level api documentation
+and instructions for the command line utilities.
 
 For a set of tutorials that walk through the construction of a behaviour tree
 for a typical robot application, refer to the documentation included with the

doc/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst