docs change

AUTHORS.rst

@@ -0,0 +1,5 @@
+
+Authors
+=======
+
+* Matthieu Berthomé - https://github.com/rienafairefr

CHANGELOG.rst

@@ -0,0 +1,3 @@
+
+Changelog
+=========

CONTRIBUTING.rst

@@ -0,0 +1,90 @@
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every
+little bit helps, and credit will always be given.
+
+Bug reports
+===========
+
+When `reporting a bug <https://github.com/rienafairefr/pynYNAB/issues>`_ please include:
+
+    * Your operating system name and version.
+    * Any details about your local setup that might be helpful in troubleshooting.
+    * Detailed steps to reproduce the bug.
+
+Documentation improvements
+==========================
+
+pyYNAB could always use more documentation, whether as part of the
+official pyYNAB docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Feature requests and feedback
+=============================
+
+The best way to send feedback is to file an issue at https://github.com/rienafairefr/pynYNAB/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that code contributions are welcome :)
+
+Development
+===========
+
+To set up `pynYNAB` for local development:
+
+1. Fork `pynYNAB <https://github.com/rienafairefr/pynYNAB>`_
+   (look for the "Fork" button).
+2. Clone your fork locally::
+
+    git clone git@github.com:your_name_here/pynYNAB.git
+
+3. Create a branch for local development::
+
+    git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+4. When you're done making changes, run all the checks, doc builder and spell checker with `tox <http://tox.readthedocs.io/en/latest/install.html>`_ one command::
+
+    tox
+
+5. Commit your changes and push your branch to GitHub::
+
+    git add .
+    git commit -m "Your detailed description of your changes."
+    git push origin name-of-your-bugfix-or-feature
+
+6. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+If you need some code review or feedback while you're developing the code just make the pull request.
+
+For merging, you should:
+
+1. Include passing tests (run ``tox``) [1]_.
+2. Update documentation when there's new API, functionality etc.
+3. Add a note to ``CHANGELOG.rst`` about the changes.
+4. Add yourself to ``AUTHORS.rst``.
+
+.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
+       `run the tests <https://travis-ci.org/rienafairefr/pynYNAB/pull_requests>`_ for each change you add in the pull request.
+
+       It will be slower though ...
+
+Tips
+----
+
+To run a subset of tests::
+
+    tox -e envname -- py.test -k test_myfeature
+
+To run all the test environments in *parallel* (you need to ``pip install detox``)::
+
+    detox

docs/authors.rst

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

docs/changelog.rst

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

docs/conf.py

@@ -0,0 +1,53 @@
+# -*- 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 = u'pynynab'
+year = u'2015-2017'
+author = u'Matthieu Berthom\\xe9'
+copyright = '{0}, {1}'.format(year, author)
+version = release = u'0.5.5'
+
+pygments_style = 'trac'
+templates_path = ['.']
+extlinks = {
+    'issue': ('https://github.com/rienafairefr/pynYNAB/issues/%s', '#'),
+    'pr': ('https://github.com/rienafairefr/pynYNAB/pull/%s', 'PR #'),
+}
+# on_rtd is whether we are on readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only set the theme if we're building docs locally
+    html_theme = 'sphinx_rtd_theme'
+
+html_use_smartypants = True
+html_last_updated_fmt = '%b %d, %Y'
+html_split_index = False
+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

docs/contributing.rst

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

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`
+

docs/installation.rst

@@ -0,0 +1,7 @@
+============
+Installation
+============
+
+At the command line::
+
+    pip install pynYNAB

docs/readme.rst

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

docs/reference/index.rst

@@ -0,0 +1,7 @@
+Reference
+=========
+
+.. toctree::
+    :glob:
+
+    pynYNAB*

docs/reference/pynYNAB.rst

@@ -0,0 +1,9 @@
+pynYNAB
+=======
+
+.. testsetup::
+
+    from pynYNAB import *
+
+.. automodule:: pynYNAB
+    :members:

docs/requirements.txt

@@ -0,0 +1,3 @@
+sphinx>=1.3
+sphinx-rtd-theme
+-e .

docs/spelling_wordlist.txt

@@ -0,0 +1,11 @@
+builtin
+builtins
+classmethod
+staticmethod
+classmethods
+staticmethods
+args
+kwargs
+callstack
+Changelog
+Indices

docs/usage.rst

@@ -0,0 +1,7 @@
+=====
+Usage
+=====
+
+To use pynYNAB in a project::
+
+	import pynYNAB