Python documentation generator
Go to file
Toshio Kuratomi ea98c3de4b environment-modules is less featureful than Lmod.
Select the default version in a different way since environment-modules
    didn't understand the symlink
  Ignore error messsages in the shell startup script as environment-modules
    prints an error message if a module has already been loaded.  The command
    is doing the right thing for this case except that it's also printing an
    error message.
2017-01-31 11:52:19 -08:00
.gitignore Update to 1.5.1 2016-12-30 15:10:00 -07:00
default-sphinx-command.in environment-modules is less featureful than Lmod. 2017-01-31 11:52:19 -08:00
html-parser-HTMLParserError-removed.patch Restore patch and require mock for tests 2015-11-25 10:17:31 -05:00
python2-sphinx Add environment-module related files 2016-12-30 12:46:55 -08:00
python3-sphinx Add environment-module related files 2016-12-30 12:46:55 -08:00
python-sphinx-xapian.patch Update to 1.5.1 2016-12-30 15:10:00 -07:00
python-sphinx.spec environment-modules is less featureful than Lmod. 2017-01-31 11:52:19 -08:00
README.fedora Add recipe for setting the system default to the README.fedora 2017-01-26 18:13:59 -08:00
sources Update to 1.5.1 2016-12-30 15:10:00 -07:00
Sphinx-1.2.1-mantarget.patch Update to 1.2.1 2014-03-04 16:20:09 +07:00
zz-modules-python-sphinx.csh environment-modules is less featureful than Lmod. 2017-01-31 11:52:19 -08:00
zz-modules-python-sphinx.sh environment-modules is less featureful than Lmod. 2017-01-31 11:52:19 -08:00

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