diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:24:33 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 05:24:33 +0000 |
| commit | 58566329c9e75f54a1f67b9d40e40b484e25c429 (patch) | |
| tree | dce1d97ade92a3b7f0cbdfce40f73ebd9fbbdc9e /python-edx-api-doc-tools.spec | |
| parent | abf777fbd1999fee61f8a30ecfaac442d821b1fd (diff) | |
automatic import of python-edx-api-doc-tools
Diffstat (limited to 'python-edx-api-doc-tools.spec')
| -rw-r--r-- | python-edx-api-doc-tools.spec | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/python-edx-api-doc-tools.spec b/python-edx-api-doc-tools.spec new file mode 100644 index 0000000..77da8dd --- /dev/null +++ b/python-edx-api-doc-tools.spec @@ -0,0 +1,99 @@ +%global _empty_manifest_terminate_build 0 +Name: python-edx-api-doc-tools +Version: 1.6.0 +Release: 1 +Summary: Tools for writing and generating API documentation for edX REST APIs +License: Apache Software License 2.0 +URL: https://github.com/edx/api-doc-tools +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/1d/76/9141de2f3fedc577e0e74eadb38f5f007d4dced6fa646dcb61079a4f31b6/edx-api-doc-tools-1.6.0.tar.gz +BuildArch: noarch + +Requires: python3-Django +Requires: python3-djangorestframework +Requires: python3-drf-yasg + +%description +|pypi| |CI| |codecov| |readthedocs| |pyversions| |license| +A toolkit for documenting REST APIs that are created with `DRF`_. +The tools use `drf-yasg`_ (DRF, yet another Swagger generator) to generate an +`OpenAPI Specification`_, which is a .json/.yaml file that describes your API. +Additionally, this package makes it easy to configure your service to expose +generated OpenAPI specification under `/api-docs.yaml` and to serve interactive +documentation under `/api-docs`. +This library was developed for use with `Open edX`_ services, but could be used +to document any Django REST Framework API. + +%package -n python3-edx-api-doc-tools +Summary: Tools for writing and generating API documentation for edX REST APIs +Provides: python-edx-api-doc-tools +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-edx-api-doc-tools +|pypi| |CI| |codecov| |readthedocs| |pyversions| |license| +A toolkit for documenting REST APIs that are created with `DRF`_. +The tools use `drf-yasg`_ (DRF, yet another Swagger generator) to generate an +`OpenAPI Specification`_, which is a .json/.yaml file that describes your API. +Additionally, this package makes it easy to configure your service to expose +generated OpenAPI specification under `/api-docs.yaml` and to serve interactive +documentation under `/api-docs`. +This library was developed for use with `Open edX`_ services, but could be used +to document any Django REST Framework API. + +%package help +Summary: Development documents and examples for edx-api-doc-tools +Provides: python3-edx-api-doc-tools-doc +%description help +|pypi| |CI| |codecov| |readthedocs| |pyversions| |license| +A toolkit for documenting REST APIs that are created with `DRF`_. +The tools use `drf-yasg`_ (DRF, yet another Swagger generator) to generate an +`OpenAPI Specification`_, which is a .json/.yaml file that describes your API. +Additionally, this package makes it easy to configure your service to expose +generated OpenAPI specification under `/api-docs.yaml` and to serve interactive +documentation under `/api-docs`. +This library was developed for use with `Open edX`_ services, but could be used +to document any Django REST Framework API. + +%prep +%autosetup -n edx-api-doc-tools-1.6.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-edx-api-doc-tools -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.6.0-1 +- Package Spec generated |
