Skip to main content

Chalice route reStructuredText autodoc directive for docutils/Sphinx.

Project description

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:
    1. The path will be added as a section title
    2. The method will be added as a section subtitle
    3. The docstring of the corresponding function will be used as the section content

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chalicedoc-0.3.tar.gz (18.3 kB view hashes)

Uploaded source

Built Distribution

chalicedoc-0.3-py2.py3-none-any.whl (7.9 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page