sanic/docs/index.rst

.. include:: ../README.rst

Guides
======

.. toctree::
   :maxdepth: 2

   getting_started
   routing
   request_data
   deploying
   static_files
   middleware
   exceptions
   blueprints
   class_based_views
   cookies
   custom_protocol
   testing
   extensions
   contributing


Module Documentation
====================

.. toctree::

   Module Reference <_api/sanic>

* :ref:`genindex`
* :ref:`search`
Convert README to RestructuredText and include it in the documentation index. 2017-01-09 22:28:33 +00:00			`.. include:: ../README.rst`
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. 2016-12-25 09:20:48 +00:00
			`Guides`
			`======`

			`.. toctree::`
			`:maxdepth: 2`

			`getting_started`
			`routing`
Clarify, reformat, and add to documentation guides (#318) * Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters * Clarify routing guide, adding introduction and HTTP types sections * Clarify the use-cases of middleware * Clean up formatting in the exceptions guide and add some common exceptions. * Fix formatting of blueprints and add use-case example. * Clarify the class-based views guide * Clarify and fix formatting of cookies guide * Clarify static files guide * Clarify the custom protocols guide. * Add more information to the deploying guide * Fix broken list in the community extensions list. * Add introduction and improve warning to contributing guide * Expand getting started guide * Reorder guides and add links between them * Standardise heading capitalisation 2017-01-20 03:18:52 +00:00			`request_data`
			`deploying`
			`static_files`
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. 2016-12-25 09:20:48 +00:00			`middleware`
			`exceptions`
			`blueprints`
			`class_based_views`
			`cookies`
Add new guides to documentation index 2017-01-18 21:54:20 +00:00			`custom_protocol`
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. 2016-12-25 09:20:48 +00:00			`testing`
Add new guides to documentation index 2017-01-18 21:54:20 +00:00			`extensions`
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. 2016-12-25 09:20:48 +00:00			`contributing`


			`Module Documentation`
			`====================`

			`.. toctree::`

Generate API documentation in the _api folder 2017-01-09 22:41:00 +00:00			`Module Reference <_api/sanic>`
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. 2016-12-25 09:20:48 +00:00
			* :ref:`genindex`
			* :ref:`search`