Python documentation generator
Go to file
Toshio Kuratomi fa7e4f510b 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.
2017-01-18 22:12:32 -08:00
.gitignore Update to 1.5.1 2016-12-30 15:10:00 -07: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 Add README.fedora so people know how to use environment-modules to switch. 2017-01-18 22:12:32 -08:00
README.fedora Add README.fedora so people know how to use environment-modules to switch. 2017-01-18 22:12:32 -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 Add environment-module related files 2016-12-30 12:46:55 -08:00
zz-modules-python-sphinx.sh Add environment-module related files 2016-12-30 12:46:55 -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 python3 version of the modules.