Merge pull request #44 from dstufft/fix-docs

Update the documentation configuration

.travis.yml

 language: python
 python: 2.7
 env:
-  - TOXENV=py26 SODIUM_INSTALL=bundled
-  - TOXENV=py27 SODIUM_INSTALL=bundled
-  - TOXENV=py32 SODIUM_INSTALL=bundled
-  - TOXENV=py33 SODIUM_INSTALL=bundled
-  - TOXENV=pypy SODIUM_INSTALL=bundled
-  - TOXENV=py26 SODIUM_INSTALL=system
-  - TOXENV=py27 SODIUM_INSTALL=system
-  - TOXENV=py32 SODIUM_INSTALL=system
-  - TOXENV=py33 SODIUM_INSTALL=system
-  - TOXENV=pypy SODIUM_INSTALL=system
+  - TOXENV=py26 SODIUM_INSTALL=bundled CC=gcc
+  - TOXENV=py27 SODIUM_INSTALL=bundled CC=gcc
+  - TOXENV=py32 SODIUM_INSTALL=bundled CC=gcc
+  - TOXENV=py33 SODIUM_INSTALL=bundled CC=gcc
+  - TOXENV=pypy SODIUM_INSTALL=bundled CC=gcc
+  - TOXENV=py26 SODIUM_INSTALL=system CC=gcc
+  - TOXENV=py27 SODIUM_INSTALL=system CC=gcc
+  - TOXENV=py32 SODIUM_INSTALL=system CC=gcc
+  - TOXENV=py33 SODIUM_INSTALL=system CC=gcc
+  - TOXENV=pypy SODIUM_INSTALL=system CC=gcc
+  - TOXENV=py26 SODIUM_INSTALL=bundled CC=clang
+  - TOXENV=py27 SODIUM_INSTALL=bundled CC=clang
+  - TOXENV=py32 SODIUM_INSTALL=bundled CC=clang
+  - TOXENV=py33 SODIUM_INSTALL=bundled CC=clang
+  - TOXENV=pypy SODIUM_INSTALL=bundled CC=clang
+  - TOXENV=py26 SODIUM_INSTALL=system CC=clang
+  - TOXENV=py27 SODIUM_INSTALL=system CC=clang
+  - TOXENV=py32 SODIUM_INSTALL=system CC=clang
+  - TOXENV=py33 SODIUM_INSTALL=system CC=clang
+  - TOXENV=pypy SODIUM_INSTALL=system CC=clang
 
 install:
   # Add the PyPy repository

docs/conf.py

 # -*- coding: utf-8 -*-
 #
-# PyNaCl documentation build configuration file, created by
-# sphinx-quickstart on Fri Feb 22 10:04:36 2013.
-#
-# This file is execfile()d with the current directory set to its containing dir.
+# This file is execfile()d with the current directory set to its containing dir
 #
 # Note that not all possible configuration values are present in this
 # autogenerated file.
@@ -11,47 +8,51 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import os
-import sys
-
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('..'))
+#sys.path.insert(0, os.path.abspath("."))
 
-# -- General configuration -----------------------------------------------------
+import nacl
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# -- General configuration ----------------------------------------------------
 
-# Add any Sphinx extension module names here, as strings. They can be extensions
-# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode']
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = "1.0"
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions  coming with Sphinx (named "sphinx.ext.*") or your custom ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+#source_encoding = "utf-8-sig"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'PyNaCl'
-copyright = u'2013, Donald Stufft and Individual Contributors'
+project = "PyNaCl"
+copyright = "2013, Donald Stufft and Individual Contributors"
 
-# The version info for the project you're documenting, acts as replacement for
+# The version info for the project you"re documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.1'
+version = "".join(nacl.__version__.split(".")[:2])
 # The full version, including alpha/beta/rc tags.
-release = '0.1.0'
+release = nacl.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -59,18 +60,18 @@ release = '0.1.0'
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+#today = ""
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+#today_fmt = "%B %d, %Y"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
-# The reST default role (used for this markup: `text`) to use for all documents.
+# The reST default role (used for this markup: `text`) to use for all documents
 #default_role = None
 
-# If true, '()' will be appended to :func: etc. cross-reference text.
+# If true, "()" will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
@@ -82,21 +83,17 @@ exclude_patterns = ['_build']
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
-intersphinx_mapping = {
-    'python': ('http://docs.python.org/3/', None)
-}
 
-
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output --------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # 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
@@ -125,11 +122,11 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+#html_last_updated_fmt = "%b %d, %Y"
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
@@ -163,108 +160,18 @@ html_static_path = ['_static']
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+#html_use_opensearch = ""
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PyNaCldoc'
-
-
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
-  ('index', 'PyNaCl.tex', u'PyNaCl Documentation',
-   u'Donald Stufft', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'pynacl', u'PyNaCl Documentation',
-     [u'Donald Stufft'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- 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 = [
-  ('index', 'PyNaCl', u'PyNaCl Documentation',
-   u'Donald Stufft', 'PyNaCl', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-
-# -- Mock Dependencies ---------------------------------------------------------
+htmlhelp_basename = "PyNaCldoc"
 
-class Mock(object):
-    def __init__(self, *args, **kwargs):
-        pass
 
-    def __call__(self, *args, **kwargs):
-        return Mock()
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {"http://docs.python.org/": None}
 
-    @classmethod
-    def __getattr__(cls, name):
-        if name in ("__file__", "__path__"):
-            return "/dev/null"
-        elif name in ("__name__",):
-            return "mocked"
-        else:
-            return Mock()
 
-MOCK_MODULES = ["cffi"]
-for mod_name in MOCK_MODULES:
-    sys.modules[mod_name] = Mock()
+# Enable the new ReadTheDocs theme
+RTD_NEW_THEME = True

tox.ini

 [tox]
-envlist = py26,py27,pypy,py32,py33
+envlist = py26,py27,pypy,py32,py33,docs,pep8
 
 [testenv]
 deps =
-    coverage
     pytest
+    coverage
+    pretend
 commands =
     coverage run --source nacl --branch -m pytest
     coverage report -m
+
+[testenv:docs]
+deps =
+    sphinx
+    cffi
+basepython = python2.7
+commands =
+    sphinx-build -W -b html -d {envtmpdir}/doctrees docs docs/_build/html
+    sphinx-build -W -b doctest -d {envtmpdir}/doctrees docs docs/_build/html
+    sphinx-build -W -b linkcheck docs docs/_build/html
+
+[testenv:pep8]
+deps = flake8
+commands = flake8 .
+
+[flake8]
+exclude = .tox,*.egg