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


Release history Release notifications

This version
History Node

0.3

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.

Filename, size & hash SHA256 hash help File type Python version Upload date
chalicedoc-0.3-py2.py3-none-any.whl (7.9 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Feb 20, 2018
chalicedoc-0.3.tar.gz (18.3 kB) Copy SHA256 hash SHA256 Source None Feb 20, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page