Opened 7 years ago

Last modified 7 years ago

#54326 assigned defect

Unable to use sphinx to build documentation for py35-pip

Reported by: drallensmith Owned by: stromnov (Andrey Stromnov)
Priority: Normal Milestone:
Component: ports Version: 2.4.1
Keywords: Cc:
Port: py-pip

Description

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.)

Change History (4)

comment:1 Changed 7 years ago by drallensmith

Cc: drallensmith added

comment:2 Changed 7 years ago by mf2k (Frank Schima)

Cc: jmroot drallensmith removed
Keywords: sphinx python sphinx-build docs documentation removed
Owner: set to jmroot
Port: py-pip py-sphinx added; py35-pip py35-sphinx py27-sphinx removed
Status: newassigned

comment:3 Changed 7 years ago by jmroot (Joshua Root)

Cc: stromnov michel.sylvan@… removed
Owner: changed from jmroot to stromnov
Port: py-sphinx removed

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.

comment:4 Changed 7 years ago 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).

Note: See TracTickets for help on using tickets.