[Bug 975670] [NEW] Documentation fails to specifying sphinx requirement
Public bug reported: Sphinx is required to build the documentation. However, it is not automatically installed and the installation documentation fails to instruct that it be installed before building the online docs. ** Affects: mailman Importance: Undecided Status: New ** Tags: mailman3 ** Tags added: mailman3 -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specifying sphinx requirement To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
** Changed in: mailman Status: New => Triaged ** Changed in: mailman Importance: Undecided => High -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specifying sphinx requirement To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
How does one build the docs with sphinx installed? src/mailman/docs/START.rst says run "python setup.py build_sphinx" but that doesn't work. It says build_sphinx is an unknown command. "python setup.py build" runs, but doesn't build the docs. I tried "python conf.py build_sphinx" and all it did was make a symlink from build/sphinx/html/index.html to README.html which doesn't exist. (this is with the current head - rev 7149 - of the branch) -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specifying sphinx requirement To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
Regarding my question above, with Richard Wackerbarth's help, I have resolved my issue. The issue is that if one is running in an active virtualenv, with sphinx installed globally but not in the virtualenv, you have to either install sphinx in the virtualenv or run setup with the global python, e.g. '/usr/bin/python setup.py build_sphinx'. -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specifying sphinx requirement To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
In addition to the requirement for sphinx, the src/mailman/docs/8-miles- high.rst document uses the sphinx graphviz extension and requires that at least the 'dot' command (part of graphviz) be installed somewhere in the current path. ** Summary changed: - Documentation fails to specifying sphinx requirement + Documentation fails to specify sphinx requirement and graphviz requirement. -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specify sphinx requirement and graphviz requirement. To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
For ubuntu there is the package python-sphinx. So apt-get install python-sphinx enables "python setup.py build_sphinx" to run correctly. -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specify sphinx requirement and graphviz requirement. To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
This bug has been moved to the new gitlab repo here: https://gitlab.com/mailman/mailman/issues/12 -- You received this bug notification because you are a member of Mailman Coders, which is subscribed to GNU Mailman. https://bugs.launchpad.net/bugs/975670 Title: Documentation fails to specify sphinx requirement and graphviz requirement. To manage notifications about this bug go to: https://bugs.launchpad.net/mailman/+bug/975670/+subscriptions
participants (5)
-
Abhilash Raj
-
Barry Warsaw
-
Mark Sapiro
-
Richard Wackerbarth
-
Staffan Ericsson