Merge pull request #33 from RonnyPfannschmidt/docs-quickstart

add sphinx autodoc api doc

Author: nicoddemus

docs/api_reference.rst

@@ -0,0 +1,11 @@
+
+
+Api Reference
+=============
+
+.. automodule:: pluggy
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+    

docs/conf.py

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+import pkg_resources
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+
+dist = pkg_resources.get_distribution('pluggy')
+project = dist.project_name
+copyright = u'2016, Holger Krekel'
+author = 'Holger Krekel'
+
+release = dist.version
+# The short X.Y version.
+version = u'.'.join(dist.version.split('.')[:2])
+
+
+language = None
+
+pygments_style = 'sphinx'
+html_theme = 'alabaster'
+html_static_path = ['_static']
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pluggy', u'pluggy Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pluggy', u'pluggy Documentation',
+     author, 'pluggy', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

docs/index.rst

@@ -0,0 +1,23 @@
+.. pluggy documentation master file, created by
+   sphinx-quickstart on Mon Nov 14 11:08:31 2016.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pluggy's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   api_reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

tox.ini

@@ -19,6 +19,16 @@ commands =
     py.test --flakes -m flakes pluggy.py testing/test_pluggy.py
     rst-lint CHANGELOG.rst README.rst
 
+
+[testenv:docs]
+deps =
+    sphinx
+    pygments
+
+commands =
+    sphinx-build \
+        -b html \
+        {toxinidir}/docs {toxinidir}/build/html-docs
 [pytest]
 minversion=2.0
 #--pyargs --doctest-modules --ignore=.tox