691795 - cfx docs fails if package directory name != package name

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P2)

Description

[Will Bamberg [:wbamberg]]

cfx docs requires the name of the directory containing a package to be the same as the name of the package. The rest of cfx doesn't.

This is a bad experience for people using third party modules, as they'll probably download the third party package from (for example) GitHub, and it will probably not have the same name as the package.

Comment 1

[Will Bamberg [:wbamberg]]

Attachment: Tolerate package directory != package name

Comment 2

[Brian Warner [:warner :bwarner]]

Comment on attachment 564642 [details] [diff] [review]
Tolerate package directory != package name

Only tiny notes:

* there are some tiny whitespace fixes: the call to get_documented_modules() should be all on the same line, and there's some extra whitespace added on the second line of _create_package_summaries().

* incidentally, src_dir.split(os.sep)[-1] can be written more idiomatically as os.path.basename(src_dir)

Otherwise looks good!

Comment 3

[Will Bamberg [:wbamberg]]

Thanks Warner. I made those changes and landed it in https://github.com/mozilla/addon-sdk/commit/4e00787176602a47c7ccec5764867a0619ffcbc6