Merge lp:~manishsinha/microfiber/add-warning-when-sphinx-missing into lp:microfiber

Status: Merged
Merged at revision: 77
Proposed branch: lp:~manishsinha/microfiber/add-warning-when-sphinx-missing
Merge into: lp:microfiber
Diff against target: 11 lines (+1/-0)
1 file modified
setup.py (+1/-0)
To merge this branch: bzr merge lp:~manishsinha/microfiber/add-warning-when-sphinx-missing
Reviewer Review Type Date Requested Status
Jason Gerard DeRose Approve
Review via email: mp+74913@code.launchpad.net

Description of the change

When Sphinx is missing, then documentation is not generated. This one line patch adds a warning when sphinx is missing thereby alerting the user

To post a comment you must log in.
Revision history for this message
Jason Gerard DeRose (jderose) wrote :

Nice attention to detail, Manish.

One small issue: so the package is actually python-sphinx as there isn't a python3-sphinx yet. You can still build the reStructuredText documentation for a python3 package, but you can't use the sphinx auto-doc feature yet (I likewise don't think you can use the sphinx auto-doctest feature).

review: Needs Fixing
78. By Manish Sinha (मनीष सिन्हा)

Removed myself from copyrights and changed python3-sphinx to python-sphinx

Revision history for this message
Jason Gerard DeRose (jderose) wrote :

Thanks!

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'setup.py'
2--- setup.py 2011-09-02 08:36:08 +0000
3+++ setup.py 2011-09-11 17:44:25 +0000
4@@ -106,6 +106,7 @@
5 build.run(self)
6 sphinx = '/usr/bin/sphinx-build'
7 if not path.isfile(sphinx):
8+ print("WARNING: Documentation not generated. python-sphinx missing")
9 return
10 tree = path.dirname(path.abspath(__file__))
11 src = path.join(tree, 'doc')

Subscribers

People subscribed via source and target branches