1
0
mirror of https://git.FreeBSD.org/ports.git synced 2024-12-23 04:23:08 +00:00
freebsd-ports/textproc/py-os-api-ref/pkg-descr
Martin Wilke 85757943d1 Sphinx Extensions to support API reference sites in OpenStack.
The package is a collection of sphinx stanzas that assist in building an API
Reference site for an OpenStack project in RST. RST is great for unstructured
English, but displaying semi structured (and repetitive) data in tables is not
its strength. This provides tooling to insert semi-structured data describing
request and response parameters and status or error messages, and turn those
into nice tables.

The package also includes a set of styling (and javascript) that is expected to
layer on top of a Sphinx theme base. This addition provides a nice set of
collapsing sections for REST methods and javascript controls to expand or
collapse all sections.

WWW: https://docs.openstack.org/os-api-ref/

PR:		228846
Submitted by:	freebsd_ports@k-worx.org
Sponsored by:	iXsystems Inc.
2018-07-06 17:49:21 +00:00

16 lines
768 B
Plaintext

Sphinx Extensions to support API reference sites in OpenStack.
The package is a collection of sphinx stanzas that assist in building an API
Reference site for an OpenStack project in RST. RST is great for unstructured
English, but displaying semi structured (and repetitive) data in tables is not
its strength. This provides tooling to insert semi-structured data describing
request and response parameters and status or error messages, and turn those
into nice tables.
The package also includes a set of styling (and javascript) that is expected to
layer on top of a Sphinx theme base. This addition provides a nice set of
collapsing sections for REST methods and javascript controls to expand or
collapse all sections.
WWW: https://docs.openstack.org/os-api-ref/