diff options
author | CoprDistGit <infra@openeuler.org> | 2023-05-31 06:26:55 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-05-31 06:26:55 +0000 |
commit | 17b59e1ced64fe4994c175ad4dde1ac21f742102 (patch) | |
tree | a46900cd2a3b4968511f21b692ab42bf26c1f044 | |
parent | d0990334cddb620fe221109025a9b2a8447ea233 (diff) |
automatic import of python-sphinx-selective-exclude
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-sphinx-selective-exclude.spec | 129 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 131 insertions, 0 deletions
@@ -0,0 +1 @@ +/sphinx_selective_exclude-1.0.3.tar.gz diff --git a/python-sphinx-selective-exclude.spec b/python-sphinx-selective-exclude.spec new file mode 100644 index 0000000..826a624 --- /dev/null +++ b/python-sphinx-selective-exclude.spec @@ -0,0 +1,129 @@ +%global _empty_manifest_terminate_build 0 +Name: python-sphinx-selective-exclude +Version: 1.0.3 +Release: 1 +Summary: Sphinx eager ".. only::" directive and other selective rendition extensions +License: MIT license +URL: https://github.com/pfalcon/sphinx_selective_exclude +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c2/07/4d6cb9dbe1b06be5caa21eed9813ac1e5ca5b29f3728be1d5e52f1cd7267/sphinx_selective_exclude-1.0.3.tar.gz +BuildArch: noarch + + +%description +Project home page: https://github.com/pfalcon/sphinx_selective_exclude +The implementation of ".. only::" directive in Sphinx documentation +generation tool is known to violate principles of least user surprise +and user expectations in general. Instead of excluding content early +in the pipeline (pre-processor style), Sphinx defers exclusion until +output phase, and what's the worst, various stages processing ignore +"only" blocks and their exclusion status, so they may leak unexpected +information into ToC, indexes, etc. +There's multiple issues submitted upstream on this matter: +* https://github.com/sphinx-doc/sphinx/issues/2150 +* https://github.com/sphinx-doc/sphinx/issues/1717 +* https://github.com/sphinx-doc/sphinx/issues/1488 +* etc. +They are largely ignored by Sphinx maintainers. +This projects tries to rectify situation on users' side. It actually +changes the way Sphinx processes "only" directive, but does this +without forking the project, and instead is made as a standard +Sphinx extension, which a user may add to their documentation config. +Unlike normal extensions, extensions provided in this package +monkey-patch Sphinx core to work in a way expected by users. + +%package -n python3-sphinx-selective-exclude +Summary: Sphinx eager ".. only::" directive and other selective rendition extensions +Provides: python-sphinx-selective-exclude +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-sphinx-selective-exclude +Project home page: https://github.com/pfalcon/sphinx_selective_exclude +The implementation of ".. only::" directive in Sphinx documentation +generation tool is known to violate principles of least user surprise +and user expectations in general. Instead of excluding content early +in the pipeline (pre-processor style), Sphinx defers exclusion until +output phase, and what's the worst, various stages processing ignore +"only" blocks and their exclusion status, so they may leak unexpected +information into ToC, indexes, etc. +There's multiple issues submitted upstream on this matter: +* https://github.com/sphinx-doc/sphinx/issues/2150 +* https://github.com/sphinx-doc/sphinx/issues/1717 +* https://github.com/sphinx-doc/sphinx/issues/1488 +* etc. +They are largely ignored by Sphinx maintainers. +This projects tries to rectify situation on users' side. It actually +changes the way Sphinx processes "only" directive, but does this +without forking the project, and instead is made as a standard +Sphinx extension, which a user may add to their documentation config. +Unlike normal extensions, extensions provided in this package +monkey-patch Sphinx core to work in a way expected by users. + +%package help +Summary: Development documents and examples for sphinx-selective-exclude +Provides: python3-sphinx-selective-exclude-doc +%description help +Project home page: https://github.com/pfalcon/sphinx_selective_exclude +The implementation of ".. only::" directive in Sphinx documentation +generation tool is known to violate principles of least user surprise +and user expectations in general. Instead of excluding content early +in the pipeline (pre-processor style), Sphinx defers exclusion until +output phase, and what's the worst, various stages processing ignore +"only" blocks and their exclusion status, so they may leak unexpected +information into ToC, indexes, etc. +There's multiple issues submitted upstream on this matter: +* https://github.com/sphinx-doc/sphinx/issues/2150 +* https://github.com/sphinx-doc/sphinx/issues/1717 +* https://github.com/sphinx-doc/sphinx/issues/1488 +* etc. +They are largely ignored by Sphinx maintainers. +This projects tries to rectify situation on users' side. It actually +changes the way Sphinx processes "only" directive, but does this +without forking the project, and instead is made as a standard +Sphinx extension, which a user may add to their documentation config. +Unlike normal extensions, extensions provided in this package +monkey-patch Sphinx core to work in a way expected by users. + +%prep +%autosetup -n sphinx-selective-exclude-1.0.3 + +%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-sphinx-selective-exclude -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 1.0.3-1 +- Package Spec generated @@ -0,0 +1 @@ +c17ba9ff85e5062a9e985b98b64b1b09 sphinx_selective_exclude-1.0.3.tar.gz |