Merge pull request #857 from adamtheturtle/sphinx

Progress towards Sphinx

Author: adamtheturtle

dev-requirements.txt

@@ -1,5 +1,6 @@
 PyYAML==3.13
 Pygments==2.2.0
+Sphinx==1.8.1
 VWS-Python-Mock==2018.10.02.0
 autoflake==1.2
 check-manifest==0.37

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = DCOSE2E
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/index.rst

@@ -0,0 +1,2 @@
+VWS Python
+==========

setup.cfg

@@ -6,6 +6,7 @@ ignore =
     .markdownlint.json
     .pydocstyle
     .remarkrc
+    .readthedocs.yml
     .style.yapf
     .travis.yml
     CHANGELOG.rst