[MacPorts] #54326: Unable to use sphinx to build documentation for py35-pip

classic Classic list List threaded Threaded
4 messages Options
Reply | Threaded
Open this post in threaded view
|

[MacPorts] #54326: Unable to use sphinx to build documentation for py35-pip

MacPorts
#54326: Unable to use sphinx to build documentation for py35-pip
-------------------------------------+-------------------------------------
 Reporter:  drallensmith             |      Owner:
     Type:  defect                   |     Status:  new
 Priority:  Normal                   |  Milestone:
Component:  ports                    |    Version:  2.4.1
 Keywords:  sphinx python sphinx-    |       Port:  py35-pip py35-sphinx
  build docs documentation           |  py27-sphinx
-------------------------------------+-------------------------------------
 Attempting to run sphinx-build -b man (with select set to either
 py35-sphinx or py27-sphinx) in the /opt/local/share/doc/py35-pip directory
 (using any of `sudo make man`, `sudo -H sphinx-build -b man . _build/man`,
 or variants on these) yields the following:

 {{{
 Running Sphinx v1.6.2
 making output directory...

 Extension error:
 Could not import extension docs.pipext (exception: No module named 'docs')
 }}}

 I have tried putting in "docs" in the directory as a symlink to ".", as
 suggested in the only webpage I could locate that mentions this specific
 error with sphinx, but with no effect.

 Thanks,

 -Allen (Allen W. Smith, Ph.D.)

--
Ticket URL: <https://trac.macports.org/ticket/54326>
MacPorts <https://www.macports.org/>
Ports system for macOS
Reply | Threaded
Open this post in threaded view
|

Re: [MacPorts] #54326: Unable to use sphinx to build documentation for py35-pip

MacPorts
#54326: Unable to use sphinx to build documentation for py35-pip
-------------------------------+----------------------
  Reporter:  drallensmith      |      Owner:  jmroot
      Type:  defect            |     Status:  assigned
  Priority:  Normal            |  Milestone:
 Component:  ports             |    Version:  2.4.1
Resolution:                    |   Keywords:
      Port:  py-pip py-sphinx  |
-------------------------------+----------------------
Changes (by mf2k):

 * status:  new => assigned
 * cc: jmroot, drallensmith (removed)
 * owner:   => jmroot
 * keywords:  sphinx python sphinx-build docs documentation =>
 * port:  py35-pip py35-sphinx py27-sphinx => py-pip py-sphinx


--
Ticket URL: <https://trac.macports.org/ticket/54326#comment:2>
MacPorts <https://www.macports.org/>
Ports system for macOS
Reply | Threaded
Open this post in threaded view
|

Re: [MacPorts] #54326: Unable to use sphinx to build documentation for py35-pip

MacPorts
In reply to this post by MacPorts
#54326: Unable to use sphinx to build documentation for py35-pip
---------------------------+----------------------
  Reporter:  drallensmith  |      Owner:  stromnov
      Type:  defect        |     Status:  assigned
  Priority:  Normal        |  Milestone:
 Component:  ports         |    Version:  2.4.1
Resolution:                |   Keywords:
      Port:  py-pip        |
---------------------------+----------------------
Changes (by jmroot):

 * cc: stromnov, michel.sylvan@… (removed)
 * owner:  jmroot => stromnov
 * port:  py-pip py-sphinx => py-pip


Comment:

 Are you sure this is even supposed to work outside the pip build
 directory? It seems odd that the pip port is installing the python scripts
 for building the docs, and not just the docs themselves, in the first
 place.

--
Ticket URL: <https://trac.macports.org/ticket/54326#comment:3>
MacPorts <https://www.macports.org/>
Ports system for macOS
Reply | Threaded
Open this post in threaded view
|

Re: [MacPorts] #54326: Unable to use sphinx to build documentation for py35-pip

MacPorts
In reply to this post by MacPorts
#54326: Unable to use sphinx to build documentation for py35-pip
---------------------------+----------------------
  Reporter:  drallensmith  |      Owner:  stromnov
      Type:  defect        |     Status:  assigned
  Priority:  Normal        |  Milestone:
 Component:  ports         |    Version:  2.4.1
Resolution:                |   Keywords:
      Port:  py-pip        |
---------------------------+----------------------

Comment (by drallensmith):

 It would certainly make sense for all Python ports to automatically
 install the appropriate manpages (I'm new to Python; would it be
 appropriate for extracted docstrings to also be part of the manpages,
 BTW?). Ideally, they would also have a "doc" variant installing the other
 files needed to produce documentation in other formats (including doing so
 outside of the build directory).

--
Ticket URL: <https://trac.macports.org/ticket/54326#comment:4>
MacPorts <https://www.macports.org/>
Ports system for macOS