Chalicedoc 0.3 | Coderz Repository

chalicedoc 0.3

Last updated:

0 purchases

chalicedoc 0.3 Image
chalicedoc 0.3 Images

Free

Languages

Categories

Add to Cart

Description:

chalicedoc 0.3

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:

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

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

License:

For personal and professional use. You cannot resell or redistribute these repositories in their original state.

Files In This Product: (if this is empty don't purchase this product)

Customer Reviews

There are no reviews.