Trying to use sphinxcontrib-programoutput

46 views
Skip to first unread message

Doug Latornell

unread,
Apr 22, 2014, 9:07:07 PM4/22/14
to read-t...@googlegroups.com
I recently started to use the sphinxcontrib-programoutput extension to help keep help output in the docs from a command-line in sync with what's actually generated by the code. It works fine when I build the docs locally but fails with "No such file or directory" errors when it build on readthedocs. See http://salishsea-meopar-tools.readthedocs.org/en/latest/SalishSeaCmd/salishsea-cmd.html#available-commands

So, I guess the first question is: Is it even possible for this to work as it required my packages command to run in the rtd environment?

I'm using a virtualenv build and installing my package via a -e line in my docs/requirements.txt file. I can see from the build logs (https://readthedocs.org/builds/salishsea-meopar-tools/1318308/ for example) that the package and its dependencies all install successfully in the venv, and the script is apparently in the venv bin/ directory. So, the only thing that I can think of is that the venv bin/ is not in the PATH.

Any suggestions on how to make this work, or am I just asking too much?

tia...

Doug

Khai Do

unread,
Nov 5, 2014, 3:44:14 AM11/5/14
to read-t...@googlegroups.com
I am having the same problem.  I believe there is a compatibility bug with sphinx 1.2.2 and sphinxcontrib-programoutput.  When i run with sphinx 1.2.2 i get the following "ERROR: Command u'jenkins-jobs --help' failed: [Errno 2] No such file or directory".  When I run with sphinx 1.1.3 it works just fine.  It seems like rtfd.com always runs with sphinx ver 1.2.2 even when you pass it a requirements file that specifies an older version of sphinx.  That's why its working in your local env but not on rtfd.com.  I think readthedocs needs to fix their build engine to run with a version of sphinx that's specified in the user provided requirements file.    
Reply all
Reply to author
Forward
0 new messages