Metadata-Version: 2.0
Name: chalicedoc
Version: 0.2.2
Summary: Chalice route reStructuredText autodoc directive for docutils/Sphinx.
Home-page: https://github.com/amaas-fintech/chalicedoc
Author: Joshua Ringer
Author-email: josh.ringer@argomi.com
License: Apache License Version 2.0
Description-Content-Type: UNKNOWN
Keywords: chalice docutils rst sphinx
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
Requires-Dist: docutils
Requires-Dist: sphinx

==========
Chalicedoc
==========

Chalicedoc makes documenting Chalice applications easier.

This module adds a "chalice" domain for reStructuredText, which can be
used by Sphinx/docutils to autogenerate documentation of your chalice routes
using the docstrings in your Chalice app.

Usage (Sphinx)
==============

Usage is simple. First, you must include the ``chalicedoc`` module in your
extensions list in *conf.py*::

  extensions = [
      ...,
      'chalicedoc',
  ]

Next, within your .rst source, use the "chalice:project" directive to scan your
app for docstrings::

  .. chalice:project:: path/to/chalice/project

This will product output as follows:

1. The title will be adapted from the chalice ``app_name``
2. The docstring of your module will be included as a summary
3. For each route:

  a. The path will be added as a section title
  b. The method will be added as a section subtitle
  c. The docstring of the corresponding function will be used as the section
     content


