Upgrade skel. Add docs dir.

12 files changed, 124 insertions, 0 deletions

diff --git a/docs/authors.rst b/docs/authors.rst
new file mode 100644
index 0000000..e122f91
--- /dev/null
+++ b/docs/authors.rst
@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst
diff --git a/docs/changelog.rst b/docs/changelog.rst
new file mode 100644
index 0000000..565b052
--- /dev/null
+++ b/docs/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..98fff0d
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+import os
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.coverage',
+    'sphinx.ext.doctest',
+    'sphinx.ext.extlinks',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+]
+if os.getenv('SPELLCHECK'):
+    extensions += 'sphinxcontrib.spelling',
+    spelling_show_suggestions = True
+    spelling_lang = 'en_US'
+
+source_suffix = '.rst'
+master_doc = 'index'
+project = 'tblib'
+year = '2013-2016'
+author = 'Ionel Cristian Mărieș'
+copyright = '{0}, {1}'.format(year, author)
+version = release = '1.2.0'
+
+pygments_style = 'trac'
+templates_path = ['.']
+extlinks = {
+    'issue': ('https://github.com/ionelmc/python-tblib/issues/%s', '#'),
+    'pr': ('https://github.com/ionelmc/python-tblib/pull/%s', 'PR #'),
+}
+import sphinx_py3doc_enhanced_theme
+html_theme = "sphinx_py3doc_enhanced_theme"
+html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
+html_theme_options = {
+    'githuburl': 'https://github.com/ionelmc/python-tblib/'
+}
+
+html_use_smartypants = True
+html_last_updated_fmt = '%b %d, %Y'
+html_split_index = True
+html_sidebars = {
+   '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'],
+}
+html_short_title = '%s-%s' % (project, version)
+
+napoleon_use_ivar = True
+napoleon_use_rtype = False
+napoleon_use_param = False
diff --git a/docs/contributing.rst b/docs/contributing.rst
new file mode 100644
index 0000000..e582053
--- /dev/null
+++ b/docs/contributing.rst
@@ -0,0 +1 @@
+.. include:: ../CONTRIBUTING.rst
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..40f35b5
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,22 @@
+========
+Contents
+========
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   reference/index
+   contributing
+   authors
+   changelog
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 0000000..790ec7c
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,7 @@
+============
+Installation
+============
+
+At the command line::
+
+    pip install tblib
diff --git a/docs/readme.rst b/docs/readme.rst
new file mode 100644
index 0000000..72a3355
--- /dev/null
+++ b/docs/readme.rst
@@ -0,0 +1 @@
+.. include:: ../README.rst
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
new file mode 100644
index 0000000..42fbe62
--- /dev/null
+++ b/docs/reference/index.rst
@@ -0,0 +1,7 @@
+Reference
+=========
+
+.. toctree::
+    :glob:
+
+    tblib*
diff --git a/docs/reference/tblib.rst b/docs/reference/tblib.rst
new file mode 100644
index 0000000..26354ee
--- /dev/null
+++ b/docs/reference/tblib.rst
@@ -0,0 +1,9 @@
+tblib
+=====
+
+.. testsetup::
+
+    from tblib import *
+
+.. automodule:: tblib
+    :members:
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..ef4a013
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,3 @@
+sphinx>=1.3
+sphinx-py3doc-enhanced-theme
+-e .
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
new file mode 100644
index 0000000..f95eb78
--- /dev/null
+++ b/docs/spelling_wordlist.txt
@@ -0,0 +1,11 @@
+builtin
+builtins
+classmethod
+staticmethod
+classmethods
+staticmethods
+args
+kwargs
+callstack
+Changelog
+Indices
diff --git a/docs/usage.rst b/docs/usage.rst
new file mode 100644
index 0000000..be510df
--- /dev/null
+++ b/docs/usage.rst
@@ -0,0 +1,7 @@
+=====
+Usage
+=====
+
+To use tblib in a project::
+
+	import tblib