rpms/python-sphinx
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add README.fedora so people know how to use environment-modules to switch.

Browse source 
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:
Toshio Kuratomi 2017-01-18 22:12:32 -08:00
commit fa7e4f510b
2 changed files with 38 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.fedora Normal file
View 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.