Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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

Release History

This version
History Node

0.2.2

History Node

0.2.1

History Node

0.2

History Node

0.1

Download Files

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

File Name & Hash SHA256 Hash Help Version File Type Upload Date
chalicedoc-0.2.2-py2.py3-none-any.whl
(7.2 kB) Copy SHA256 Hash SHA256
py2.py3 Wheel Feb 14, 2018
chalicedoc-0.2.2.tar.gz
(17.2 kB) Copy SHA256 Hash SHA256
Source Feb 14, 2018

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting