* [gentoo-commits] repo/proj/guru:dev commit in: dev-python/os-api-ref/
@ 2021-07-11 0:38 Alessandro Barbieri
0 siblings, 0 replies; 2+ messages in thread
From: Alessandro Barbieri @ 2021-07-11 0:38 UTC (permalink / raw
To: gentoo-commits
commit: 6fe56ee56c0b39dc902648ff74a36bdd960528e1
Author: Alessandro Barbieri <lssndrbarbieri <AT> gmail <DOT> com>
AuthorDate: Sun Jul 11 00:38:20 2021 +0000
Commit: Alessandro Barbieri <lssndrbarbieri <AT> gmail <DOT> com>
CommitDate: Sun Jul 11 00:38:20 2021 +0000
URL: https://gitweb.gentoo.org/repo/proj/guru.git/commit/?id=6fe56ee5
dev-python/os-api-ref: initial import
Signed-off-by: Alessandro Barbieri <lssndrbarbieri <AT> gmail.com>
dev-python/os-api-ref/Manifest | 1 +
dev-python/os-api-ref/metadata.xml | 16 +++++++++++
dev-python/os-api-ref/os-api-ref-2.2.0.ebuild | 39 +++++++++++++++++++++++++++
3 files changed, 56 insertions(+)
diff --git a/dev-python/os-api-ref/Manifest b/dev-python/os-api-ref/Manifest
new file mode 100644
index 000000000..737e39255
--- /dev/null
+++ b/dev-python/os-api-ref/Manifest
@@ -0,0 +1 @@
+DIST os-api-ref-2.2.0.tar.gz 93273 BLAKE2B 9da508d51993f5b71474d39e818bfdc897023a6104e708c6c30b807bb20891f05685aa241605d1cf30540b75108e7914c932ba7aa6fa1619961c11ab2c7ee6d8 SHA512 3d25b3cd702c611577c86c206a60f92d929191f9e75c210e04c639c2a597ea58d31c81c17b79e41276c3e5b391e2c7bb95a9d7483b0f248e230d03550da3af96
diff --git a/dev-python/os-api-ref/metadata.xml b/dev-python/os-api-ref/metadata.xml
new file mode 100644
index 000000000..6c1e9a2f6
--- /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.2.0.ebuild b/dev-python/os-api-ref/os-api-ref-2.2.0.ebuild
new file mode 100644
index 000000000..0fe45c50b
--- /dev/null
+++ b/dev-python/os-api-ref/os-api-ref-2.2.0.ebuild
@@ -0,0 +1,39 @@
+# Copyright 1999-2021 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI="8"
+
+PYTHON_COMPAT=( python3_{8..9} )
+
+inherit distutils-r1
+
+DESCRIPTION="Sphinx Extensions to support API reference sites in OpenStack"
+HOMEPAGE="https://docs.openstack.org/os-api-ref/latest"
+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[${PYTHON_USEDEP}]
+"
+BDEPEND="
+ ${RDEPEND}
+ test? (
+ >=dev-python/beautifulsoup-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"
+
+python_test() {
+ pytest -vv --deselect os_api_ref/tests/test_microversions.py::TestMicroversions::test_parameters_table || die
+}
^ permalink raw reply related [flat|nested] 2+ messages in thread
* [gentoo-commits] repo/proj/guru:dev commit in: dev-python/os-api-ref/
@ 2022-03-14 3:28 Alessandro Barbieri
0 siblings, 0 replies; 2+ messages in thread
From: Alessandro Barbieri @ 2022-03-14 3:28 UTC (permalink / raw
To: gentoo-commits
commit: b5d55e72fa13b0c5ce56a6f0a4ba3b2414b90dfa
Author: Alessandro Barbieri <lssndrbarbieri <AT> gmail <DOT> com>
AuthorDate: Mon Mar 14 03:28:06 2022 +0000
Commit: Alessandro Barbieri <lssndrbarbieri <AT> gmail <DOT> com>
CommitDate: Mon Mar 14 03:28:06 2022 +0000
URL: https://gitweb.gentoo.org/repo/proj/guru.git/commit/?id=b5d55e72
dev-python/os-api-ref: add 2.3.0, drop 2.2.0
Signed-off-by: Alessandro Barbieri <lssndrbarbieri <AT> gmail.com>
dev-python/os-api-ref/Manifest | 2 +-
...os-api-ref-2.2.0.ebuild => os-api-ref-2.3.0.ebuild} | 18 +++++++++---------
2 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/dev-python/os-api-ref/Manifest b/dev-python/os-api-ref/Manifest
index 737e39255..04b388085 100644
--- a/dev-python/os-api-ref/Manifest
+++ b/dev-python/os-api-ref/Manifest
@@ -1 +1 @@
-DIST os-api-ref-2.2.0.tar.gz 93273 BLAKE2B 9da508d51993f5b71474d39e818bfdc897023a6104e708c6c30b807bb20891f05685aa241605d1cf30540b75108e7914c932ba7aa6fa1619961c11ab2c7ee6d8 SHA512 3d25b3cd702c611577c86c206a60f92d929191f9e75c210e04c639c2a597ea58d31c81c17b79e41276c3e5b391e2c7bb95a9d7483b0f248e230d03550da3af96
+DIST os-api-ref-2.3.0.tar.gz 92864 BLAKE2B 48d74f40a4b865520ec1b61235245f2571262c14c46f994d9b6655a33376a981732212ad4f38b894e495e6381302054eb455516de03b2d2f87662c8f29f4650d SHA512 e53063df90393c17e764e640c4ad5e1e6f1da7286ce9da6bdd460d54e2f831022a366c9cb711b95d8bfa872294309620f2d44cd4910277971ff2f2719c5d81eb
diff --git a/dev-python/os-api-ref/os-api-ref-2.2.0.ebuild b/dev-python/os-api-ref/os-api-ref-2.3.0.ebuild
similarity index 72%
rename from dev-python/os-api-ref/os-api-ref-2.2.0.ebuild
rename to dev-python/os-api-ref/os-api-ref-2.3.0.ebuild
index 76e9c9352..c98ce0e43 100644
--- a/dev-python/os-api-ref/os-api-ref-2.2.0.ebuild
+++ b/dev-python/os-api-ref/os-api-ref-2.3.0.ebuild
@@ -1,14 +1,18 @@
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-EAPI="8"
+EAPI=8
+EPYTEST_DESELECT=( os_api_ref/tests/test_microversions.py::TestMicroversions::test_parameters_table )
PYTHON_COMPAT=( python3_{8..9} )
inherit distutils-r1
DESCRIPTION="Sphinx Extensions to support API reference sites in OpenStack"
-HOMEPAGE="https://docs.openstack.org/os-api-ref/latest"
+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"
@@ -19,10 +23,10 @@ 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[${PYTHON_USEDEP}]
+ >=dev-python/sphinx-4.0.0[${PYTHON_USEDEP}]
"
+DEPEND="${RDEPEND}"
BDEPEND="
- ${RDEPEND}
test? (
>=dev-python/beautifulsoup4-4.6.0[${PYTHON_USEDEP}]
>=dev-python/sphinx-testing-1.0.1[${PYTHON_USEDEP}]
@@ -33,7 +37,3 @@ BDEPEND="
distutils_enable_tests pytest
distutils_enable_sphinx doc/source ">=dev-python/openstackdocstheme-2.2.1"
-
-python_test() {
- pytest -vv --deselect os_api_ref/tests/test_microversions.py::TestMicroversions::test_parameters_table || die
-}
^ permalink raw reply related [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-03-14 3:28 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-03-14 3:28 [gentoo-commits] repo/proj/guru:dev commit in: dev-python/os-api-ref/ Alessandro Barbieri
-- strict thread matches above, loose matches on Subject: below --
2021-07-11 0:38 Alessandro Barbieri
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox