===================================
Self-Documentation for Pyramid Apps
===================================
A Pyramid plugin that makes a Pyramid application self-documenting via
inspection/reflection to:
1. Describe the application URL structure,
2. Extract documentation from Python comments, and
3. Generate formal syntax using commenting conventions.
The resulting documentation can be served by the application to an
HTTP request or displayed on the command line. It has built-in support
for plain-text hierachies, reStructuredText, HTML, PDF, JSON, YAML,
WADL, and XML, however other custom formats can be added easily.
Exposing an application's structure via HTTP is useful to dynamically
generate an API description (via WADL, JSON, or YAML) or to create
documentation directly from source code.
On the command-line it is useful to get visibility into an
application's URL structure and hierarchy so that it can be understood
and maintained.
.. note::
Although pyramid-describe is intended to be able to describe any
kind of pyramid application, currently it only supports
pyramid-controllers_ based dispatch.
.. note::
Currently, pyramid-describe can only inspect the first Controller
it finds -- this will eventually be fixed to correctly implement
the `inspect` option.
Self-Documentation for Pyramid Apps
===================================
A Pyramid plugin that makes a Pyramid application self-documenting via
inspection/reflection to:
1. Describe the application URL structure,
2. Extract documentation from Python comments, and
3. Generate formal syntax using commenting conventions.
The resulting documentation can be served by the application to an
HTTP request or displayed on the command line. It has built-in support
for plain-text hierachies, reStructuredText, HTML, PDF, JSON, YAML,
WADL, and XML, however other custom formats can be added easily.
Exposing an application's structure via HTTP is useful to dynamically
generate an API description (via WADL, JSON, or YAML) or to create
documentation directly from source code.
On the command-line it is useful to get visibility into an
application's URL structure and hierarchy so that it can be understood
and maintained.
.. note::
Although pyramid-describe is intended to be able to describe any
kind of pyramid application, currently it only supports
pyramid-controllers_ based dispatch.
.. note::
Currently, pyramid-describe can only inspect the first Controller
it finds -- this will eventually be fixed to correctly implement
the `inspect` option.
1 maintainer
Release files for pyramid_describe 0.5.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 | |
|---|---|---|---|
| pyramid_describe-0.5.3.tar.gz | 167.6 kB | Details |
Release files / pyramid_describe-0.5.3.tar.gz
| Download URL | pyramid_describe-0.5.3.tar.gz |
|---|---|
| Size | 167.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c596025a21c8da8dfd7c89ee296de7a9adcaec3bf101a33b752a0cd291c7deba
|
|
BLAKE2b-256 checksum How to use checksums |
ba8613240513b884138318c685797dbed9459e4b807ef07eb4757c5e40731677
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
