BSD Ports

textproc/py-os-api-ref 3.0.1_1 DragonFly

Sphinx Extensions to support API reference sites in OpenStack

System
DragonFly
Repository
DPorts
Maintainer
[email protected] (as in FreeBSD)
License
APACHE20
Categories
python, textproc
Package size
87.3 KiB, 299.8 KiB installed

Description

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.

In the other systems

SystemPortVersion
DragonFlytextproc/py-os-api-ref3.0.1_1
FreeBSDtextproc/py-os-api-ref3.2.0

Install

Binary package:

pkg install py311-os-api-ref

From DPorts:

cd /usr/dports/textproc/py-os-api-ref && make install clean

Dependencies

Run dependencies 5

No port depends on this one.