sanic/docs/index.rst

.. include:: ../README.rst

User Guide
==========

To learn about using Sanic, checkout the `User Guide <https://sanicframework.org/guide/>`_.

API
======

.. toctree::
   :maxdepth: 4

   👥 User Guide <https://sanicframework.org/guide/>
   sanic/api_reference
   💻 Source code <https://github.com/sanic-org/sanic/>
   ❓ Support <https://community.sanicframework.org/>


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

.. toctree::

* :ref:`genindex`
* :ref:`modindex`
Change order of Docs index 2021-03-03 07:26:22 +00:00			`.. include:: ../README.rst`

Docs changes for RTD 2021-03-03 07:21:44 +00:00			`User Guide`
			`==========`

			To learn about using Sanic, checkout the `User Guide <https://sanicframework.org/guide/>`_.

Update Sphinx docs to use README 2021-03-01 21:08:11 +00:00			`API`
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			`======`

			`.. toctree::`
Additonal annotations 2021-01-29 14:19:10 +00:00			`:maxdepth: 4`
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
Docs changes for RTD 2021-03-03 07:21:44 +00:00			`👥 User Guide <https://sanicframework.org/guide/>`
improve doc and remove warnings 2017-07-02 18:02:04 +01:00			`sanic/api_reference`
Docs changes for RTD 2021-03-03 07:21:44 +00:00			`💻 Source code <https://github.com/sanic-org/sanic/>`
			`❓ Support <https://community.sanicframework.org/>`
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

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

			`.. toctree::`

			* :ref:`genindex`
improve doc and remove warnings 2017-07-02 18:02:04 +01:00			* :ref:`modindex`