Documentation fails to specify sphinx requirement and graphviz requirement.

Bug #975670 reported by Richard Wackerbarth on 2012-04-07
This bug affects 2 people
Affects Status Importance Assigned to Milestone
GNU Mailman

Bug Description

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.

tags: added: mailman3
Barry Warsaw (barry) on 2012-04-07
Changed in mailman:
status: New → Triaged
importance: Undecided → High
Mark Sapiro (msapiro) wrote :

How does one build the docs with sphinx installed?

src/mailman/docs/START.rst says run "python build_sphinx" but that doesn't work. It says build_sphinx is an unknown command. "python build" runs, but doesn't build the docs.

I tried "python 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)

Mark Sapiro (msapiro) wrote :

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 build_sphinx'.

Mark Sapiro (msapiro) wrote :

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: - Documentation fails to specifying sphinx requirement
+ Documentation fails to specify sphinx requirement and graphviz
+ requirement.

For ubuntu there is the package python-sphinx.

So apt-get install python-sphinx enables "python build_sphinx" to run correctly.

Abhilash Raj (raj-abhilash1) wrote :

This bug has been moved to the new gitlab repo here:

To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers