Add README.fedora so people know how to use environment-modules to switch.
Change the default to be the python2 version to match with the guidelines Switch to generic environment(modules) instead of Lmod specifically.
This commit is contained in:
parent
4944f766cd
commit
fa7e4f510b
17
README.fedora
Normal file
17
README.fedora
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
Sphinx with autodoc is sensitive to whether it is run via Python2 or Python3
|
||||||
|
as it uses the Python version that it is invoked with to parse the source
|
||||||
|
files for docstrings. Unfortunately, there's no logic to detect this within
|
||||||
|
the sphinx commands and the standard Makefiles generated by sphinx-quickstart
|
||||||
|
don't give the user any hint that it might be a problem.
|
||||||
|
|
||||||
|
The Fedora package tries to mitigate this problem by allowing the user to
|
||||||
|
switch between the Python2 and Python3 versions using environment-modules. To
|
||||||
|
switch to the Python3 commands, use::
|
||||||
|
|
||||||
|
module swap python-sphinx/python3-sphinx
|
||||||
|
|
||||||
|
To switch to the Python2 version, use::
|
||||||
|
|
||||||
|
module swap python-sphinx/python2-sphinx
|
||||||
|
|
||||||
|
The default install uses the python3 version of the modules.
|
@ -4,18 +4,18 @@
|
|||||||
%{!?python_sitelib: %global python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print (get_python_lib())")}
|
%{!?python_sitelib: %global python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print (get_python_lib())")}
|
||||||
%endif
|
%endif
|
||||||
|
|
||||||
# At some point, RHEL will need to be in here too
|
# Currently, python2 version is always the default: https://fedoraproject.org/wiki/Packaging:Python#Naming
|
||||||
%if 0%{?fedora} && 0%{?fedora} > 24
|
%if 1
|
||||||
%global py3_default 1
|
|
||||||
%else
|
|
||||||
%global py3_default 0
|
%global py3_default 0
|
||||||
|
%else
|
||||||
|
%global py3_default 1
|
||||||
%endif
|
%endif
|
||||||
|
|
||||||
%global upstream_name Sphinx
|
%global upstream_name Sphinx
|
||||||
|
|
||||||
Name: python-sphinx
|
Name: python-sphinx
|
||||||
Version: 1.5.1
|
Version: 1.5.1
|
||||||
Release: 1%{?dist}
|
Release: 2%{?dist}
|
||||||
Summary: Python documentation generator
|
Summary: Python documentation generator
|
||||||
|
|
||||||
Group: Development/Tools
|
Group: Development/Tools
|
||||||
@ -31,6 +31,7 @@ Source1: python2-sphinx
|
|||||||
Source2: python3-sphinx
|
Source2: python3-sphinx
|
||||||
Source3: zz-modules-python-sphinx.sh
|
Source3: zz-modules-python-sphinx.sh
|
||||||
Source4: zz-modules-python-sphinx.csh
|
Source4: zz-modules-python-sphinx.csh
|
||||||
|
Source5: README.fedora
|
||||||
#Patch0: Sphinx-1.2.1-mantarget.patch
|
#Patch0: Sphinx-1.2.1-mantarget.patch
|
||||||
# Upstream fix for xapian 1.4
|
# Upstream fix for xapian 1.4
|
||||||
# https://github.com/sphinx-doc/sphinx/commit/cf795894b9290c5ab2035ae21535f0a7f4b7107a
|
# https://github.com/sphinx-doc/sphinx/commit/cf795894b9290c5ab2035ae21535f0a7f4b7107a
|
||||||
@ -166,10 +167,10 @@ Requires: python2-six
|
|||||||
Requires: python2-sphinx-theme-alabaster
|
Requires: python2-sphinx-theme-alabaster
|
||||||
Requires: python2-imagesize
|
Requires: python2-imagesize
|
||||||
Requires: python2-requests
|
Requires: python2-requests
|
||||||
Requires(posttrans): Lmod
|
Requires: environment(modules)
|
||||||
# Needed to get rid of the alternatives config installed in f24 and f25
|
# Needed to get rid of the alternatives config installed in f24 and f25
|
||||||
# versions of the package
|
# versions of the package
|
||||||
Requires(posttrans): /usr/sbin/alternatives
|
Requires(pre): /usr/sbin/alternatives
|
||||||
Recommends: graphviz
|
Recommends: graphviz
|
||||||
Obsoletes: python-sphinx <= 1.2.3
|
Obsoletes: python-sphinx <= 1.2.3
|
||||||
Obsoletes: python-sphinxcontrib-napoleon < 0.5
|
Obsoletes: python-sphinxcontrib-napoleon < 0.5
|
||||||
@ -277,16 +278,15 @@ Requires: python3-imagesize
|
|||||||
Requires: python3-requests
|
Requires: python3-requests
|
||||||
Requires: python3-six
|
Requires: python3-six
|
||||||
Recommends: graphviz
|
Recommends: graphviz
|
||||||
Requires(posttrans): Lmod
|
Requires: environment(modules)
|
||||||
# Needed to get rid of the alternatives config installed in f24 and f25
|
# Needed to get rid of the alternatives config installed in f24 and f25
|
||||||
# versions of the package
|
# versions of the package
|
||||||
Requires(posttrans): /usr/sbin/alternatives
|
Requires(pre): /usr/sbin/alternatives
|
||||||
Obsoletes: python3-sphinxcontrib-napoleon < 0.3.0
|
Obsoletes: python3-sphinxcontrib-napoleon < 0.3.0
|
||||||
Provides: python3-sphinxcontrib-napoleon = %{version}-%{release}
|
Provides: python3-sphinxcontrib-napoleon = %{version}-%{release}
|
||||||
Provides: python(Sphinx) = %{version}-%{release}
|
Provides: python(Sphinx) = %{version}-%{release}
|
||||||
%{?python_provide:%python_provide python3-sphinx}
|
%{?python_provide:%python_provide python3-sphinx}
|
||||||
Conflicts: python2-Sphinx < %{version}-%{release}
|
Conflicts: python2-Sphinx < %{version}-%{release}
|
||||||
Conflicts: python2-sphinx < %{version}-%{release}
|
|
||||||
|
|
||||||
%description -n python3-sphinx
|
%description -n python3-sphinx
|
||||||
Sphinx is a tool that makes it easy to create intelligent and
|
Sphinx is a tool that makes it easy to create intelligent and
|
||||||
@ -353,6 +353,8 @@ This package contains locale files for Sphinx
|
|||||||
%prep
|
%prep
|
||||||
%autosetup -n %{upstream_name}-%{version}%{?prerel} -p1
|
%autosetup -n %{upstream_name}-%{version}%{?prerel} -p1
|
||||||
|
|
||||||
|
cp %{SOURCE5} .
|
||||||
|
|
||||||
sed '1d' -i sphinx/pycode/pgen2/token.py
|
sed '1d' -i sphinx/pycode/pgen2/token.py
|
||||||
|
|
||||||
# fix line encoding of bundled jquery.js
|
# fix line encoding of bundled jquery.js
|
||||||
@ -457,7 +459,7 @@ ln -s python3-sphinx %{buildroot}%{_modulesdir}/python-sphinx/default
|
|||||||
# therefore, environment modules is not loaded). The user can immediately
|
# therefore, environment modules is not loaded). The user can immediately
|
||||||
# switch them by using module swap python-sphinx/python2-sphinx
|
# switch them by using module swap python-sphinx/python2-sphinx
|
||||||
for filename in sphinx-{build,apidoc,autogen,quickstart} ; do
|
for filename in sphinx-{build,apidoc,autogen,quickstart} ; do
|
||||||
ln -s %{_libexecdir}/python3-sphinx/$filename %{buildroot}%{_bindir}/$filename
|
ln -s %{_libexecdir}/python3-sphinx/$filename %{buildroot}%{_bindir}/$filename
|
||||||
done
|
done
|
||||||
|
|
||||||
%else
|
%else
|
||||||
@ -467,7 +469,7 @@ ln -s python2-sphinx %{buildroot}%{_modulesdir}/python-sphinx/default
|
|||||||
# therefore, environment modules is not loaded). The user can immediately
|
# therefore, environment modules is not loaded). The user can immediately
|
||||||
# switch them by using module swap python-sphinx/python3-sphinx
|
# switch them by using module swap python-sphinx/python3-sphinx
|
||||||
for filename in sphinx-{build,apidoc,autogen,quickstart} ; do
|
for filename in sphinx-{build,apidoc,autogen,quickstart} ; do
|
||||||
ln -s %{_libexecdir}/python2-sphinx/$filename %{buildroot}%{_bindir}/$filename
|
ln -s %{_libexecdir}/python2-sphinx/$filename %{buildroot}%{_bindir}/$filename
|
||||||
done
|
done
|
||||||
|
|
||||||
%endif
|
%endif
|
||||||
@ -520,7 +522,7 @@ popd
|
|||||||
|
|
||||||
%files -n python2-sphinx
|
%files -n python2-sphinx
|
||||||
%license LICENSE
|
%license LICENSE
|
||||||
%doc AUTHORS CHANGES EXAMPLES README.rst
|
%doc AUTHORS CHANGES EXAMPLES README.rst README.fedora
|
||||||
%{_bindir}/sphinx-*-2*
|
%{_bindir}/sphinx-*-2*
|
||||||
%{python2_sitelib}/sphinx/
|
%{python2_sitelib}/sphinx/
|
||||||
%{python2_sitelib}/Sphinx-%{version}-py%{python2_version}.egg-info/
|
%{python2_sitelib}/Sphinx-%{version}-py%{python2_version}.egg-info/
|
||||||
@ -538,7 +540,7 @@ popd
|
|||||||
|
|
||||||
%files -n python3-sphinx
|
%files -n python3-sphinx
|
||||||
%license LICENSE
|
%license LICENSE
|
||||||
%doc AUTHORS CHANGES EXAMPLES README.rst
|
%doc AUTHORS CHANGES EXAMPLES README.rst README.fedora
|
||||||
%{_bindir}/sphinx-*-3*
|
%{_bindir}/sphinx-*-3*
|
||||||
%{_bindir}/sphinx-build
|
%{_bindir}/sphinx-build
|
||||||
%{_bindir}/sphinx-apidoc
|
%{_bindir}/sphinx-apidoc
|
||||||
@ -562,6 +564,11 @@ popd
|
|||||||
|
|
||||||
|
|
||||||
%changelog
|
%changelog
|
||||||
|
* Wed Jan 18 2017 Toshio Kuratomi <toshio@fedoraproject.org> - - 1.5.1-2
|
||||||
|
- Add README.fedora so people know how to use environment-modules to switch.
|
||||||
|
- Change the default to be the python2 version to match with the guidelines
|
||||||
|
- Switch to generic environment(modules) instead of Lmod specifically.
|
||||||
|
|
||||||
* Fri Dec 30 2016 Orion Poplawski <orion@cora.nwra.com> - 1.5.1-1
|
* Fri Dec 30 2016 Orion Poplawski <orion@cora.nwra.com> - 1.5.1-1
|
||||||
- Update to 1.5.1
|
- Update to 1.5.1
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user