Merge pull request #10 from RonnyPfannschmidt/docs

set up a initial sphinx skeleton

.gitignore

@@ -22,6 +22,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+.env/
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

docs/about.rst

@@ -0,0 +1,8 @@
+about deprecate
+================
+
+The deprecate library provides decorators and primitives to support
+API deprecation and experimentation.
+
+The goal is to support rich and documenting deprecation of API's
+as projects move towards new needs.

docs/api.rst

@@ -0,0 +1,8 @@
+Api
+===
+
+
+
+.. automodule:: deprecate
+
+  .. autofunction:: deprecated

docs/basics.rst

@@ -0,0 +1,4 @@
+Basics
+=======
+
+TODO!!

docs/conf.py

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+import pkg_resources
+__distribution = pkg_resources.get_distribution('deprecate')
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+
+# General information about the project.
+project = __distribution.project_name
+copyright = u'2015, Milan Falešník'
+author = u'Milan Falešník'
+
+
+# The short X.Y version.
+version = u'1.x'
+# The full version, including alpha/beta/rc tags.
+release = __distribution.version
+version = '.'.join(release.split('.')[:2])
+
+exclude_patterns = []
+
+pygments_style = 'sphinx'
+todo_include_todos = False
+
+
+html_theme = 'haiku'
+html_static_path = ['_static']
+
+htmlhelp_basename = 'deprecatedoc'

docs/index.rst

@@ -0,0 +1,21 @@
+
+Welcome to deprecate's documentation!
+=====================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   about
+   basics
+   api
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

tox.ini

@@ -10,5 +10,14 @@ skip_install = true
 deps= flake8
 commands = flake8 {posargs:src testing}
 
+[testenv:docs]
+deps = sphinx
+commands =
+  sphinx-build \
+    -b html \
+    -d build/sphinx-doctrees \
+    docs build/htmldocs
+
+
 [flake8]
 max_line_length = 100