Make RTD actually work.

.gitignore

@@ -10,3 +10,4 @@ dist/
 /.tox/
 .coverage
 htmlcov/
+docs/_build/

MANIFEST.in

@@ -10,9 +10,9 @@ include nose2.cfg
 include tox.ini
 include .travis.yml
 include *.txt
-include .nti_cover_package
-recursive-include doc *.py
-recursive-include doc *.rst
-recursive-include doc Makefile
-recursive-exclude doc changelog.rst
+exclude .nti_cover_package
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include docs Makefile
+
 recursive-include src *.zcml

README.rst

@@ -2,8 +2,26 @@
  nti.externalization
 =====================
 
+.. image:: https://img.shields.io/pypi/v/nti.externalization.svg
+        :target: https://pypi.python.org/pypi/nti.externalization/
+        :alt: Latest release
+
+.. image:: https://img.shields.io/pypi/pyversions/nti.externalization.svg
+        :target: https://pypi.org/project/nti.externalization/
+        :alt: Supported Python versions
+
 .. image:: https://travis-ci.org/NextThought/nti.externalization.svg?branch=master
-    :target: https://travis-ci.org/NextThought/nti.externalization
+        :target: https://travis-ci.org/NextThought/nti.externalization
 
 .. image:: https://coveralls.io/repos/github/NextThought/nti.externalization/badge.svg?branch=master
-    :target: https://coveralls.io/github/NextThought/nti.externalization?branch=master
+        :target: https://coveralls.io/github/NextThought/nti.externalization?branch=master
+
+.. image:: https://readthedocs.org/projects/ntiexternalization/badge/?version=latest
+        :target: https://ntiexternalization.readthedocs.io/en/latest/
+        :alt: Documentation Status
+
+A flexible, schema-driven system for converting Python objects to and
+from external formats such as JSON and YAML. This works well in a
+zope.component environment such as Pyramid.
+
+Documentation is hosted at https://ntiexternalization.readthedocs.io/

doc-requirements.txt

@@ -1,4 +1,6 @@
 setuptools >= 33.1.1
+persistent
+BTrees
 zope.interface
 zope.proxy
 repoze.sphinx.autointerface

doc/conf.py → docs/conf.py

@@ -19,7 +19,11 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+import os
+import sys
+import pkg_resources
+sys.path.append(os.path.abspath('../src'))
+rqmt = pkg_resources.require('nti.externalization')[0]
 
 # -- General configuration ------------------------------------------------
 
@@ -58,12 +62,10 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The full version, including alpha/beta/rc tags.
-with open('../version.txt') as f:
-    release = f.read().strip()
-
 # The short X.Y version.
-version = '.'.join(release.split('.')[:2])
+version = '%s.%s' % tuple(map(int, rqmt.version.split('.')[:2]))
+# The full version, including alpha/beta/rc tags.
+release = rqmt.version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -89,7 +91,7 @@
 # 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

setup.py

@@ -19,7 +19,7 @@ def _read(fname):
 
 setup(
     name='nti.externalization',
-    version=_read('version.txt').strip(),
+    version='1.0.0.dev0',
     author='Jason Madden',
     author_email='jason@nextthought.com',
     description="NTI Externalization",
@@ -78,6 +78,11 @@ def _read(fname):
     ],
     extras_require={
         'test': TESTS_REQUIRE,
+        'docs': [
+            'Sphinx',
+            'repoze.sphinx.autointerface',
+            'sphinx_rtd_theme',
+        ]
     },
     entry_points=entry_points,
 )

tox.ini

@@ -1,6 +1,6 @@
 [tox]
 envlist =
-   py27,py35,py36,pypy,pypy3,coverage
+   py27,py35,py36,pypy,pypy3,coverage,docs
 
 [testenv]
 commands =
@@ -18,3 +18,9 @@ commands =
 deps =
     {[testenv]deps}
     coverage
+
+[testenv:docs]
+commands =
+    sphinx-build -b html -d docs/_build/doctrees docs docs/_build/html
+deps =
+    .[docs]