setup should show a warning when documentation cannot be generated due to missing sphinx

Bug #846954 reported by Manish Sinha (मनीष सिन्हा)
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
FileStore
Fix Released
High
Manish Sinha (मनीष सिन्हा)
Microfiber
Fix Released
High
Manish Sinha (मनीष सिन्हा)

Bug Description

I tried running setup.py without sphinx installed and I get

$ ./setup.py build
running build
running build_py
creating build
creating build/lib
copying filestore.py -> build/lib
running build_scripts
creating build/scripts-3.2
copying and adjusting dmediasum -> build/scripts-3.2
changing mode of build/scripts-3.2/dmediasum from 664 to 775

There isn't any mention that documentation generation cannot go forward.

Now after I install sphinx, I get
$ ./setup.py build
running build
running build_py
running build_scripts
Making output directory...
Running Sphinx v1.0.7
loading pickled environment... not yet created
building [html]: targets for 4 source files that are out of date
updating environment: 4 added, 0 changed, 0 removed
reading sources... [100%] protocol
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] protocol
writing additional files... genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded.

Please add a warning message like
"WARNING: Documentation generation failed because sphinx is not installed".

This looks trivial but is a boon in disguise for packagers who will have no clue why documentation is not being generated.

Same holds for microfiber too

summary: - Filestore setu should show a warning when documentation cannot be
+ Filestore setup should show a warning when documentation cannot be
generated due to missing sphinx
summary: - Filestore setup should show a warning when documentation cannot be
- generated due to missing sphinx
+ setup should show a warning when documentation cannot be generated due
+ to missing sphinx
description: updated
Changed in microfiber:
assignee: nobody → Manish Sinha (मनीष सिन्हा) (manishsinha)
Changed in filestore:
assignee: nobody → Manish Sinha (मनीष सिन्हा) (manishsinha)
Changed in filestore:
importance: Undecided → High
Changed in microfiber:
importance: Undecided → High
status: New → In Progress
Changed in filestore:
status: New → In Progress
Changed in microfiber:
status: In Progress → Fix Committed
milestone: none → 11.09
Changed in filestore:
milestone: none → 11.09
Changed in filestore:
status: In Progress → Fix Committed
Changed in microfiber:
status: Fix Committed → Fix Released
Changed in filestore:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.