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.
This commit is contained in:
Martin Wilke 2018-07-06 17:49:21 +00:00
parent 6d38327284
commit 85757943d1
Notes: svn2git 2021-03-31 03:12:20 +00:00
svn path=/head/; revision=474025
4 changed files with 45 additions and 0 deletions

View file

@ -1331,6 +1331,7 @@
SUBDIR += py-openpyxl
SUBDIR += py-openstackdocstheme
SUBDIR += py-orange3-text
SUBDIR += py-os-api-ref
SUBDIR += py-pager
SUBDIR += py-pandocfilters
SUBDIR += py-paragrep

View file

@ -0,0 +1,26 @@
# $FreeBSD$
PORTNAME= os-api-ref
DISTVERSION= 1.5.0
CATEGORIES= textproc python
MASTER_SITES= CHEESESHOP
PKGNAMEPREFIX= ${PYTHON_PKGNAMEPREFIX}
MAINTAINER= freebsd_ports@k-worx.org
COMMENT= Sphinx Extensions to support API reference sites in OpenStack
LICENSE= APACHE20
LICENSE_FILE= ${WRKSRC}/LICENSE
BUILD_DEPENDS= ${PYTHON_PKGNAMEPREFIX}pbr>=2.0.0:devel/py-pbr@${PY_FLAVOR}
RUN_DEPENDS= ${PYTHON_PKGNAMEPREFIX}pbr>=2.0.0:devel/py-pbr@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}yaml>=3.10:devel/py-yaml@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}six>=1.10.0:devel/py-six@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}sphinx>=1.6.2:textproc/py-sphinx@${PY_FLAVOR} \
${PYTHON_PKGNAMEPREFIX}openstackdocstheme>=1.6.2:textproc/py-openstackdocstheme@${PY_FLAVOR}
USES= python
USE_PYTHON= distutils autoplist
NO_ARCH= yes
.include <bsd.port.mk>

View file

@ -0,0 +1,3 @@
TIMESTAMP = 1527330146
SHA256 (os-api-ref-1.5.0.tar.gz) = f37ab6cbc9d24421499ec61fe33aa8f79b0d640ce1ef93aaa875394ee300f7c0
SIZE (os-api-ref-1.5.0.tar.gz) = 89821

View file

@ -0,0 +1,15 @@
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/