- 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 python2 version of the modules.

- If the system administrator wishes to change the default, edit the

- /etc/profile.d/zz-modules-python-sphinx.sh and

- /etc/profile.d/zz-modules-python-sphinx.csh files to specify a specific

- alternative to use.  For instance, to make the python3 version the default,

- modify it like so::

- 

-     @@ -1,2 +1,2 @@

-      # Add path to the default python-sphinx scripts on this version of Fedora

-     -module load python-sphinx

-     +module load python-sphinx/python3-sphinx

- #%Module1.0

- set ModuleVersion  "python@PYTHONVER@-sphinx"

- %if 0%{?fedora} || 0%{?rhel} > 7

- %global with_python3 1

- %else

- %{!?python_sitelib: %global python_sitelib %(%{__python} -c "from distutils.sysconfig import get_python_lib; print (get_python_lib())")}

- %endif

- # When bootstrapping sphinx, we don't yet have sphinxcontrib-websupport

- %bcond_without websupport

- # Also, we don't have all the tests requirements

- %bcond_without tests

- 

- # Currently, python2 version is always the default: https://fedoraproject.org/wiki/Packaging:Python#Naming

- %if 1

- %global py3_default 0

- %else

- %global py3_default 1

- %endif

- Version:    1.8.4

- 

- # sphinx/util/stemmer.py Public Domain

- # sphinx/pycode/pgen2 Python

- # jquery (MIT or GPLv2)

- License:    BSD and Public Domain and Python and (MIT or GPLv2)

- URL:        http://sphinx-doc.org/

- Source0:    https://files.pythonhosted.org/packages/source/S/%{upstream_name}/%{upstream_name}-%{version}.tar.gz

- Source1:    python2-sphinx

- Source2:    python3-sphinx

- Source3:    zz-modules-python-sphinx.sh

- Source4:    zz-modules-python-sphinx.csh

- Source5:    README.fedora

- # environment-modules file to select whether the py2 or py3 version of

- # python-sphinx execuitables is default

- Source6:    default-sphinx-command.in

- 

- # Make the test_latex_remote_images an expected failure

- # since it requires an active internet connection

- # to fetch images, which is not possible in koji or mock.

- Patch0: xfail-test_latex_remote_images.patch

- 

- # Allow extra themes to exist. We pull in python[23]-sphinx-theme-alabaster

- Patch1: sphinx-test_theming.diff

- BuildRequires: python2-devel >= 2.4

- BuildRequires: python2-babel

- BuildRequires: python2-setuptools

- BuildRequires: python2-docutils

- BuildRequires: python2-jinja2

- BuildRequires: python2-pygments >= 2.0

- BuildRequires: python2-six

- BuildRequires: python2-sphinx_rtd_theme

- BuildRequires: python2-sphinx-theme-alabaster

- BuildRequires: python2-imagesize

- BuildRequires: python2-requests

- BuildRequires: python2-packaging

- BuildRequires: python2-typing

- BuildRequires: python2-sphinxcontrib-websupport

- BuildRequires: environment(modules)

- BuildRequires: python2-nose

- BuildRequires: python2-pytest

- BuildRequires: python2-pytest-cov

- BuildRequires: texinfo

- BuildRequires: python2-sqlalchemy

- BuildRequires: python2-mock

- BuildRequires: python2-html5lib

- BuildRequires: python2-whoosh

- BuildRequires: python2-snowballstemmer

- BuildRequires: python2-enum34

- BuildRequires: texlive-ucs

- BuildRequires: tex(ecrm1000.tfm)

- BuildRequires: tex(footnote.sty)

- BuildRequires: tex(multirow.sty)

- BuildRequires: tex(threeparttable.sty)

- BuildRequires: tex(capt-of.sty)

- BuildRequires: tex(needspace.sty)

- BuildRequires: tex(eqparbox.sty)

- BuildRequires: tex(amsmath.sty)

- BuildRequires: tex(amsthm.sty)

- BuildRequires: tex(amssymb.sty)

- BuildRequires: tex(amsfonts.sty)

- BuildRequires: tex(bm.sty)

- BuildRequires: tex(palatino.sty)

- BuildRequires: tex(multirow.sty)

- BuildRequires: tex(eqparbox.sty)

- BuildRequires: tex(atbegshi.sty)

- BuildRequires: tex(anyfontsize.sty)

- BuildRequires: tex(luatex85.sty)

- BuildRequires: tex(fncychap.sty)

- BuildRequires: tex(tabulary.sty)

- BuildRequires: tex(polyglossia.sty)

- BuildRequires: tex(ctablestack.sty)

- BuildRequires: tex(eu1enc.def)

- %if 0%{?with_python3}

- BuildRequires: python3-devel

- BuildRequires: python3-babel

- BuildRequires: python3-setuptools

- BuildRequires: python3-docutils

- BuildRequires: python3-jinja2

- BuildRequires: python3-pygments

- BuildRequires: python3-six

- BuildRequires: python3-sphinx_rtd_theme

- BuildRequires: python3-sphinx-theme-alabaster

- BuildRequires: python3-packaging

- BuildRequires: python3-imagesize

- BuildRequires: python3-requests

- %if %{with websupport}

- BuildRequires: python3-sphinxcontrib-websupport

- %endif

- %if %{with tests}

- BuildRequires: python3-nose

- BuildRequires: python3-pytest

- BuildRequires: python3-pytest-cov

- BuildRequires: python3-sqlalchemy

- BuildRequires: python3-mock

- BuildRequires: python3-html5lib

- BuildRequires: python3-whoosh

- BuildRequires: python3-snowballstemmer

- %endif

- %endif # with_python3

- 

- %package -n    python2-sphinx

- Requires:      python-sphinx-locale = %{?epoch}:%{version}-%{release}

- Requires:      python2-babel

- Requires:      python2-docutils

- Requires:      python2-jinja2

- Requires:      python2-pygments

- Requires:      python2-mock

- Requires:      python2-snowballstemmer

- Requires:      python2-sphinx_rtd_theme

- Requires:      python2-six

- Requires:      python2-sphinx-theme-alabaster

- Requires:      python2-imagesize

- Requires:      python2-requests

- Requires:      python2-packaging

- Requires:      python2-typing

- %if %{with websupport}

- Requires:      python2-sphinxcontrib-websupport

- %endif

- Requires: environment(modules)

- # Needed to get rid of the alternatives config installed in f24 and f25

- # versions of the package

- Requires(pre): /usr/sbin/alternatives

- Obsoletes:     python-sphinx <= 1.2.3

- Obsoletes:     python-sphinxcontrib-napoleon < 0.5

- Provides:      python-sphinxcontrib-napoleon = %{?epoch}:%{version}-%{release}

- Obsoletes:     python2-Sphinx <= 1.3.1-4

- Provides:      python2-Sphinx = %{?epoch}:%{version}-%{release}

- Provides:      python(Sphinx) = %{?epoch}:%{version}-%{release}

- %{?python_provide:%python_provide python2-sphinx}

- Conflicts:     python3-sphinx < %{?epoch}:%{version}-%{release}

- 

- %description -n python2-sphinx

- %package latex

- Summary:       LaTeX builder dependencies for %{name}

- Requires:      python(Sphinx) = %{?epoch}:%{version}-%{release}

- Requires:      texlive-ucs

- Requires:      tex(ecrm1000.tfm)

- Requires:      tex(footnote.sty)

- Requires:      tex(multirow.sty)

- Requires:      tex(threeparttable.sty)

- Requires:      tex(capt-of.sty)

- Requires:      tex(needspace.sty)

- Requires:      tex(eqparbox.sty)

- Requires:      tex(amsmath.sty)

- Requires:      tex(amsthm.sty)

- Requires:      tex(amssymb.sty)

- Requires:      tex(amsfonts.sty)

- Requires:      tex(bm.sty)

- Requires:      tex(palatino.sty)

- Requires:      tex(multirow.sty)

- Requires:      tex(eqparbox.sty)

- Requires:      tex(atbegshi.sty)

- Requires:      tex(anyfontsize.sty)

- Requires:      tex(luatex85.sty)

- Requires:      tex(fncychap.sty)

- Requires:      tex(tabulary.sty)

- Requires:      tex(polyglossia.sty)

- Requires:      tex(ctablestack.sty)

- Requires:      tex(eu1enc.def)

- Obsoletes:     python3-sphinx-latex < 1.4.4-2

- 

- %description latex

- Sphinx is a tool that makes it easy to create intelligent and

- beautiful documentation for Python projects (or other documents

- consisting of multiple reStructuredText sources), written by Georg

- Brandl. It was originally created to translate the new Python

- documentation, but has now been cleaned up in the hope that it will be

- useful to many other projects.

- This package pulls in the TeX dependencies needed by Sphinx's LaTeX

- builder.

- %if 0%{?with_python3}

- %package -n python3-sphinx

- Summary:       Python documentation generator

- Requires:      python-sphinx-locale = %{?epoch}:%{version}-%{release}

- Requires:      python3-babel

- Requires:      python3-docutils

- Requires:      python3-jinja2

- Requires:      python3-pygments

- Requires:      python3-mock

- Requires:      python3-snowballstemmer

- Requires:      python3-sphinx_rtd_theme

- Requires:      python3-sphinx-theme-alabaster

- Requires:      python3-imagesize

- Requires:      python3-requests

- Requires:      python3-six

- Requires:      python3-packaging

- %if %{with websupport}

- Requires:      python3-sphinxcontrib-websupport

- %endif

- Recommends:    graphviz

- Recommends:    ImageMagick

- Requires: environment(modules)

- # Needed to get rid of the alternatives config installed in f24 and f25

- # versions of the package

- Requires(pre): /usr/sbin/alternatives

- Obsoletes:     python3-sphinxcontrib-napoleon < 0.3.0

- Provides:      python3-sphinxcontrib-napoleon = %{?epoch}:%{version}-%{release}

- Provides:      python(Sphinx) = %{?epoch}:%{version}-%{release}

- %{?python_provide:%python_provide python3-sphinx}

- Conflicts:     python2-Sphinx < %{?epoch}:%{version}-%{release}

- 

- %description -n python3-sphinx

- Sphinx uses reStructuredText as its markup language, and many of its

- strengths come from the power and straightforwardness of

- reStructuredText and its parsing and translating suite, the Docutils.

- 

- Although it is still under constant development, the following

- features are already present, work fine and can be seen "in action" in

- the Python docs:

- 

-     * Output formats: HTML (including Windows HTML Help) and LaTeX,

-       for printable PDF versions

-     * Extensive cross-references: semantic markup and automatic links

-       for functions, classes, glossary terms and similar pieces of

-       information

-     * Hierarchical structure: easy definition of a document tree, with

-       automatic links to siblings, parents and children

-     * Automatic indices: general index as well as a module index

-     * Code handling: automatic highlighting using the Pygments highlighter

-     * Various extensions are available, e.g. for automatic testing of

-       snippets and inclusion of appropriately formatted docstrings.

- %endif # with_python3

- Requires:      python(Sphinx) = %{?epoch}:%{version}-%{release}

- %package locale

- Summary:       Locale files for %{name}

- License:       BSD

- 

- %description locale

- Sphinx is a tool that makes it easy to create intelligent and

- beautiful documentation for Python projects (or other documents

- consisting of multiple reStructuredText sources), written by Georg

- Brandl. It was originally created to translate the new Python

- documentation, but has now been cleaned up in the hope that it will be

- useful to many other projects.

- 

- This package contains locale files for Sphinx

- 

- %autosetup -n %{upstream_name}-%{version}%{?prerel} -p1

- 

- cp %{SOURCE5} .

- %if %{without websupport}

- rm tests/test_websupport.py tests/test_api_translator.py

- %endif

- 

- %if 0%{?with_python3}

- rm -rf %{py3dir}

- cp -a . %{py3dir}

- %endif # with_python3

- %py2_build

- %if 0%{?with_python3}

- %endif # with_python3

- %if 0%{?with_python3}

- %else

- export SPHINXBUILD="%{__python2} ../sphinx/cmd/build.py"

- %endif

- 

- %if 0%{?with_python3}

-     mv %{buildroot}%{_bindir}/$i %{buildroot}%{_bindir}/$i-%{python3_version}

-     ln -s $i-%{python3_version} %{buildroot}%{_bindir}/$i-3

-     ln -s %{_bindir}/$i-3 %{buildroot}%{_libexecdir}/python3-sphinx/$i

- %endif # with_python3

- %py2_install

- install -d %{buildroot}%{_libexecdir}/python2-sphinx

- for i in sphinx-{apidoc,autogen,build,quickstart}; do

-     mv %{buildroot}%{_bindir}/$i %{buildroot}%{_bindir}/$i-%{python2_version}

-     ln -s $i-%{python2_version} %{buildroot}%{_bindir}/$i-2

-     ln -s %{_bindir}/$i-2 %{buildroot}%{_libexecdir}/python2-sphinx/$i

- done

-     ### TODO: these are all the same.  Do we really need to ship them three

-     ### times or is it fine to just ship them as e.g. sphinx-build.1

-     cp -p $f %{buildroot}%{_mandir}/man1/$(basename $f | sed -e "s|.1$|-%{python2_version}.1|")

-     cp -p $f %{buildroot}%{_mandir}/man1/$(basename $f | sed -e "s|.1$|-%{python3_version}.1|")

- 

- # Remove language files, they're identical to the ones from the

- # Python 2 build that will be moved to /usr/share below

- find %{buildroot}%{python3_sitelib}/sphinx/locale -maxdepth 1 -mindepth 1 -type d -not -path '*/\.*' -exec rm -rf '{}' \;

- # Clean up non-python files

- rm -f %{buildroot}%{python2_sitelib}/sphinx/locale/.DS_Store

- rm -rf %{buildroot}%{python2_sitelib}/sphinx/locale/.tx

- rm -f %{buildroot}%{python3_sitelib}/sphinx/locale/.DS_Store

- rm -rf %{buildroot}%{python3_sitelib}/sphinx/locale/.tx

- 

- pushd %{buildroot}%{python2_sitelib}

- install -d %{buildroot}%{_modulesdir}/python-sphinx

- install -m 0644 %{SOURCE1} %{buildroot}%{_modulesdir}/python-sphinx/

- sed -i 's|@python2_sphinx_dir@|%{_libexecdir}/python2-sphinx|' %{buildroot}%{_modulesdir}/python-sphinx/python2-sphinx

- install -m 0644 %{SOURCE2} %{buildroot}%{_modulesdir}/python-sphinx/

- sed -i 's|@python3_sphinx_dir@|%{_libexecdir}/python3-sphinx|' %{buildroot}%{_modulesdir}/python-sphinx/python3-sphinx

- install -d %{buildroot}%{_sysconfdir}/profile.d

- install -m 0644 %{SOURCE3} %{buildroot}%{_sysconfdir}/profile.d/zz-modules-python-sphinx.sh

- install -m 0644 %{SOURCE4} %{buildroot}%{_sysconfdir}/profile.d/zz-modules-python-sphinx.csh

- 

- %if %{py3_default}

- sed 's/@PYTHONVER@/3/' < %{SOURCE6} > %{buildroot}%{_modulesdir}/python-sphinx/.version

- 

- # These symlinks establish a default for when a package is first installed (and

- # therefore, environment modules is not loaded).  The user can immediately

- # switch them by using module swap python-sphinx/python2-sphinx

- for filename in sphinx-{build,apidoc,autogen,quickstart} ; do

-   ln -s %{_libexecdir}/python3-sphinx/$filename %{buildroot}%{_bindir}/$filename

- done

- 

- %else

- sed 's/@PYTHONVER@/2/' < %{SOURCE6} > %{buildroot}%{_modulesdir}/python-sphinx/.version

- 

- # These symlinks establish a default for when a package is first installed (and

- # therefore, environment modules is not loaded).  The user can immediately

- # switch them by using module swap python-sphinx/python3-sphinx

- for filename in sphinx-{build,apidoc,autogen,quickstart} ; do

-   ln -s %{_libexecdir}/python2-sphinx/$filename %{buildroot}%{_bindir}/$filename

- done

- 

- %endif

- 

- export PYTHONPATH=$PWD

- # Currently, all linkcheck tests hit external websites.  Since network access

- # is disabled in koji, we have to disable these.

- rm tests/test_build_linkcheck.py

- 

- # Igoring test_api_translator for now as it fails on Fedora.

- # The issue has been reported upstream: https://github.com/sphinx-doc/sphinx/issues/4710

- LANG=C.UTF-8 pytest-2

- %if 0%{?with_python3}

- pushd %{py3dir}

- # Currently, all linkcheck tests hit external websites.  Since network access

- # is disabled in koji, we have to disable these.

- rm tests/test_build_linkcheck.py

- pytest-3

- popd

- %endif # with_python3

- %files latex

- %license LICENSE

- 

- %files locale -f sphinx.lang

- %files -n python2-sphinx

- %license LICENSE

- %doc AUTHORS CHANGES EXAMPLES README.rst README.fedora

- %{_bindir}/sphinx-*-2*

- %{_bindir}/sphinx-build

- %{_bindir}/sphinx-apidoc

- %{_bindir}/sphinx-autogen

- %{_bindir}/sphinx-quickstart

- %{python2_sitelib}/sphinx/

- %{python2_sitelib}/Sphinx-%{version}-py%{python2_version}.egg-info/

- %exclude %{_mandir}/man1/sphinx-*-%{python3_version}.1*

- %{_mandir}/man1/*

- %{_libexecdir}/python2-sphinx/

- %{_modulesdir}/python-sphinx/python2-sphinx

- %if !%{py3_default}

- %{_modulesdir}/python-sphinx/.version

- %endif

- %config(noreplace) %{_sysconfdir}/profile.d/zz-modules-python-sphinx.sh

- %config(noreplace) %{_sysconfdir}/profile.d/zz-modules-python-sphinx.csh

- 

- %if 0%{?with_python3}

- %files -n python3-sphinx

- %license LICENSE

- %doc AUTHORS CHANGES EXAMPLES README.rst README.fedora

- %{_bindir}/sphinx-*-3*

- %{python3_sitelib}/sphinx/

- %{python3_sitelib}/Sphinx-%{version}-py%{python3_version}.egg-info/

- %{_mandir}/man1/sphinx-*-%{python3_version}.1*

- %{_libexecdir}/python3-sphinx/

- %{_modulesdir}/python-sphinx/python3-sphinx

- %if %{py3_default}

- %{_modulesdir}/python-sphinx/.version

- %endif

- %config(noreplace) %{_sysconfdir}/profile.d/zz-modules-python-sphinx.sh

- %config(noreplace) %{_sysconfdir}/profile.d/zz-modules-python-sphinx.csh

- %endif # with_python3

- #%Module 1.0

- #

- #  python2-sphinx module for use with 'environment modules' package

- #

- conflict        python-sphinx

- prepend-path    PATH            @python2_sphinx_dir@

- #%Module 1.0

- #

- #  python2-sphinx module for use with 'environment modules' package

- #

- conflict        python-sphinx

- prepend-path    PATH            @python3_sphinx_dir@

- SHA512 (Sphinx-1.8.4.tar.gz) = 6821bb56c30b52f357ae55f5db45f056883c457eae62a0751a2b654519a07bca9edccb7678b29fa380379f059c9d8899d9e7b06ceccca5ec26962e6f83bb8578

- diff --git a/tests/test_build_latex.py b/tests/test_build_latex.py

- index 55f48cd..78ccecd 100644

- --- a/tests/test_build_latex.py

- +++ b/tests/test_build_latex.py

- @@ -1009,7 +1009,7 @@ def test_latex_raw_directive(app, status, warning):

-      assert 'HTML: abc  ghi' in result

-      assert 'LaTeX: abc def ghi' in result

-  

- -

- +@pytest.mark.xfail(reason="this test requires internet connection")

-  @pytest.mark.sphinx('latex', testroot='images')

-  def test_latex_remote_images(app, status, warning):

-      app.builder.build_all()

- # Add path to the default python-sphinx scripts on this version of Fedora

- module load python-sphinx >& /dev/null

- # Add path to the default python-sphinx scripts on this version of Fedora

- module load python-sphinx 2> /dev/null