diff options
| author | Liguros - Gitlab CI/CD [develop] <gitlab@liguros.net> | 2022-04-12 21:03:09 +0000 |
|---|---|---|
| committer | Liguros - Gitlab CI/CD [develop] <gitlab@liguros.net> | 2022-04-12 21:03:09 +0000 |
| commit | d97953e6ff67978da9554e7b4601aedceb21e215 (patch) | |
| tree | 674053c902db6972b9716c9ac3b1e960ee7a5358 /dev-python/os-api-ref | |
| parent | 1d1fa5bb30df70070bbbbd2b777b839d31f09c41 (diff) | |
| download | baldeagleos-repo-d97953e6ff67978da9554e7b4601aedceb21e215.tar.gz baldeagleos-repo-d97953e6ff67978da9554e7b4601aedceb21e215.tar.xz baldeagleos-repo-d97953e6ff67978da9554e7b4601aedceb21e215.zip | |
Adding metadata
Diffstat (limited to 'dev-python/os-api-ref')
| -rw-r--r-- | dev-python/os-api-ref/Manifest | 1 | ||||
| -rw-r--r-- | dev-python/os-api-ref/metadata.xml | 16 | ||||
| -rw-r--r-- | dev-python/os-api-ref/os-api-ref-2.3.0.ebuild | 39 |
3 files changed, 56 insertions, 0 deletions
diff --git a/dev-python/os-api-ref/Manifest b/dev-python/os-api-ref/Manifest new file mode 100644 index 000000000000..04b388085db0 --- /dev/null +++ b/dev-python/os-api-ref/Manifest @@ -0,0 +1 @@ +DIST os-api-ref-2.3.0.tar.gz 92864 BLAKE2B 48d74f40a4b865520ec1b61235245f2571262c14c46f994d9b6655a33376a981732212ad4f38b894e495e6381302054eb455516de03b2d2f87662c8f29f4650d SHA512 e53063df90393c17e764e640c4ad5e1e6f1da7286ce9da6bdd460d54e2f831022a366c9cb711b95d8bfa872294309620f2d44cd4910277971ff2f2719c5d81eb diff --git a/dev-python/os-api-ref/metadata.xml b/dev-python/os-api-ref/metadata.xml new file mode 100644 index 000000000000..6c1e9a2f67c0 --- /dev/null +++ b/dev-python/os-api-ref/metadata.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE pkgmetadata SYSTEM "http://www.gentoo.org/dtd/metadata.dtd"> +<pkgmetadata> + <maintainer type="person"> + <email>lssndrbarbieri@gmail.com</email> + <name>Alessandro Barbieri</name> + </maintainer> + <longdescription lang="en"> +This project 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 project 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 / collapse all sections. +Features +Sphinx stanza rest_method describing the method and resource for a REST API call. Lets authors write simply and also gives readers a clean way to scan all methods then click a button to get more information about a method. +Sphinx stanza rest_parameters used to insert semi-structured data into the RST files describing the parameters users cansend with the request. The stanza points to a structured YAML file, parameters.yaml. +Sphinx stanza rest_status_code used to insert pointers to error or status codes returned by the service. Points to a structured YAML file, http_codes.yaml. + </longdescription> +</pkgmetadata> diff --git a/dev-python/os-api-ref/os-api-ref-2.3.0.ebuild b/dev-python/os-api-ref/os-api-ref-2.3.0.ebuild new file mode 100644 index 000000000000..4ecd699cf51d --- /dev/null +++ b/dev-python/os-api-ref/os-api-ref-2.3.0.ebuild @@ -0,0 +1,39 @@ +# Copyright 1999-2022 Gentoo Authors +# Distributed under the terms of the GNU General Public License v2 + +EAPI=8 + +EPYTEST_DESELECT=( os_api_ref/tests/test_microversions.py::TestMicroversions::test_parameters_table ) +PYTHON_COMPAT=( python3_{7,8,9,10} ) + +inherit distutils-r1 + +DESCRIPTION="Sphinx Extensions to support API reference sites in OpenStack" +HOMEPAGE=" + https://opendev.org/openstack/os-api-ref + https://pypi.org/project/os-api-ref/ +" +SRC_URI="mirror://pypi/${PN:0:1}/${PN}/${P}.tar.gz" + +LICENSE="Apache-2.0" +SLOT="0" +KEYWORDS="~amd64" + +RDEPEND=" + >=dev-python/openstackdocstheme-2.2.1[${PYTHON_USEDEP}] + >=dev-python/pyyaml-3.1.2[${PYTHON_USEDEP}] + >=dev-python/six-1.10.0[${PYTHON_USEDEP}] + >=dev-python/sphinx-4.0.0[${PYTHON_USEDEP}] +" +DEPEND="${RDEPEND}" +BDEPEND=" + test? ( + >=dev-python/beautifulsoup4-4.6.0[${PYTHON_USEDEP}] + >=dev-python/sphinx-testing-1.0.1[${PYTHON_USEDEP}] + >=dev-python/subunit-1.0.0[${PYTHON_USEDEP}] + >=dev-python/testtools-2.2.0[${PYTHON_USEDEP}] + ) +" + +distutils_enable_tests pytest +distutils_enable_sphinx doc/source ">=dev-python/openstackdocstheme-2.2.1" |
