Use Sphinx for documentation.

This commit creates configuration files and an index page for
documentation using Sphinx. The recommonmark package is used to enable
Markdown support for Sphinx, using the Common Mark specification. This
means that the current documentation doesn't need to be rewritten.

.gitignore

@@ -9,3 +9,6 @@ settings.py
 *.pyc
 .idea/*
 .cache/*
+docs/_build/
+docs/sanic.rst
+docs/modules.rst

docs/conf.py

@@ -0,0 +1,155 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Sanic documentation build configuration file, created by
+# sphinx-quickstart on Sun Dec 25 18:07:21 2016.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+
+import os
+import sys
+
+# Add support for Markdown documentation using Recommonmark
+from recommonmark.parser import CommonMarkParser
+
+# Ensure that sanic is present in the path, to allow sphinx-apidoc to
+# autogenerate documentation from docstrings
+root_directory = os.path.dirname(os.getcwd())
+sys.path.insert(0, root_directory)
+
+import sanic
+
+# -- General configuration ------------------------------------------------
+
+extensions = ['sphinx.ext.autodoc',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.githubpages']
+
+templates_path = ['_templates']
+
+# Enable support for both Restructured Text and Markdown
+source_parsers = {'.md': CommonMarkParser}
+source_suffix = ['.rst', '.md']
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Sanic'
+copyright = '2016, Sanic contributors'
+author = 'Sanic contributors'
+
+# 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 = sanic.__version__
+# The full version, including alpha/beta/rc tags.
+release = sanic.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = 'en'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+#
+# modules.rst is generated by sphinx-apidoc but is unused. This suppresses
+# a warning about it.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'modules.rst']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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 = 'alabaster'
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Sanicdoc'
+
+
+# -- 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': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Sanic.tex', 'Sanic Documentation',
+     'Sanic contributors', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'sanic', 'Sanic 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, 'Sanic', 'Sanic Documentation',
+     author, 'Sanic', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+# -- Options for Epub output ----------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+epub_author = author
+epub_publisher = author
+epub_copyright = copyright
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+

docs/contributing.md

@@ -6,5 +6,20 @@ Thank you for your interest!
 * `python -m pip install pytest`
 * `python -m pytest tests`
 
+## Documentation
+
+Sanic's documentation is built using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in Markdown and can be found in the `docs` folder, while the module reference is automatically generated using `sphinx-apidoc`.
+
+To generate the documentation from scratch:
+
+```bash
+rm -f docs/sanic.rst
+rm -f docs/modules.rst
+sphinx-apidoc -o docs/ sanic
+sphinx-build -b html docs docs/_build
+```
+
+The HTML documentation will be created in the `docs/_build` folder.
+
 ## Warning
 One of the main goals of Sanic is speed.  Code that lowers the performance of Sanic without significant gains in usability, security, or features may not be merged.

docs/index.rst

@@ -0,0 +1,90 @@
+Welcome to Sanic's documentation!
+=================================
+
+Sanic is a Flask-like Python 3.5+ web server that's written to go fast.  It's based on the work done by the amazing folks at magicstack, and was inspired by `this article <https://magic.io/blog/uvloop-blazing-fast-python-networking/>`_.
+
+On top of being Flask-like, Sanic supports async request handlers.  This means you can use the new shiny async/await syntax from Python 3.5, making your code non-blocking and speedy.
+
+Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!
+
+Benchmarks
+----------
+
+All tests were run on an AWS medium instance running ubuntu, using 1
+process. Each script delivered a small JSON response and was tested with
+wrk using 100 connections. Pypy was tested for Falcon and Flask but did
+not speed up requests.
+
++-----------+-----------------------+----------------+---------------+
+| Server    | Implementation        | Requests/sec   | Avg Latency   |
++===========+=======================+================+===============+
+| Sanic     | Python 3.5 + uvloop   | 33,342         | 2.96ms        |
++-----------+-----------------------+----------------+---------------+
+| Wheezy    | gunicorn + meinheld   | 20,244         | 4.94ms        |
++-----------+-----------------------+----------------+---------------+
+| Falcon    | gunicorn + meinheld   | 18,972         | 5.27ms        |
++-----------+-----------------------+----------------+---------------+
+| Bottle    | gunicorn + meinheld   | 13,596         | 7.36ms        |
++-----------+-----------------------+----------------+---------------+
+| Flask     | gunicorn + meinheld   | 4,988          | 20.08ms       |
++-----------+-----------------------+----------------+---------------+
+| Kyoukai   | Python 3.5 + uvloop   | 3,889          | 27.44ms       |
++-----------+-----------------------+----------------+---------------+
+| Aiohttp   | Python 3.5 + uvloop   | 2,979          | 33.42ms       |
++-----------+-----------------------+----------------+---------------+
+| Tornado   | Python 3.5            | 2,138          | 46.66ms       |
++-----------+-----------------------+----------------+---------------+
+
+Hello World Example
+-------------------
+
+.. code:: python
+
+    from sanic import Sanic
+    from sanic.response import json
+
+
+    app = Sanic()
+
+
+    @app.route("/")
+    async def test(request):
+        return json({"hello": "world"})
+
+    if __name__ == "__main__":
+        app.run(host="0.0.0.0", port=8000)
+
+Installation
+------------
+
+-  ``python -m pip install sanic``
+
+Guides
+======
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started
+   request_data
+   routing
+   middleware
+   exceptions
+   blueprints
+   class_based_views
+   cookies
+   static_files
+   testing
+   deploying
+   contributing
+
+
+Module Documentation
+====================
+
+.. toctree::
+
+   Module Reference <sanic>
+
+* :ref:`genindex`
+* :ref:`search`

requirements-dev.txt

@@ -12,3 +12,5 @@ kyoukai
 falcon
 tornado
 aiofiles
+sphinx
+recommonmark