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:
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
2 maintainers
Metadata
2 maintainers
Release files for chalicedoc 0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| chalicedoc-0.3.tar.gz | 18.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| chalicedoc-0.3-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 26.1 kB
Release files / chalicedoc-0.3.tar.gz
| Download URL | chalicedoc-0.3.tar.gz |
|---|---|
| Size | 18.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
288b31d803644173acefbacf0f8e37eeeb1c4a24c89f5f59d1cb92d66c72e357
|
|
BLAKE2b-256 checksum How to use checksums |
f9d56bd578e85f122911bf10051a68ff2aa42dca7615350f7a7439aaebaff98a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / chalicedoc-0.3-py2.py3-none-any.whl
| Download URL | chalicedoc-0.3-py2.py3-none-any.whl |
|---|---|
| Size | 7.9 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
627bcd5b28fff9f7172bf54c6a55ce3ce01198026424d583ae415b331255f707
|
|
BLAKE2b-256 checksum How to use checksums |
001d30609f4b23aab4ab78985eda469be3b7c03e7d2f066a0f73c8541a2476fb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for chalicedoc 0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
