[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: how to build sphinx doc when there is extension



Hi,

On Tue, Aug 30, 2016 at 07:14:53AM +0000, PICCA Frederic-Emmanuel wrote:
> I am using this snipset when I want to build the sphinx documentation for all python available. (this is a sort of unit test).
> Usually the sphinx doc use auto-doc and then it allows to check that all modules can be imported. 
>
> override_dh_sphinxdoc:
> ifeq (,$(findstring nodocs, $(DEB_BUILD_OPTIONS)))
> 	PYBUILD_SYSTEM=custom \
> 	PYBUILD_BUILD_ARGS="cd doc && PYTHONPATH={build_dir} http_proxy='127.0.0.1:9' {interpreter} -c \"import sys;from sphinx import main;sys.exit(main(sys.argv))\" -N -bhtml source build/html" dh_auto_build  # HTML generator
> 	dh_installdocs "doc/build/html" -p python-pyfai-doc
> 	dh_sphinxdoc -O--buildsystem=pybuild
> endif
> 
> I would like your opinion about this and if there is better way to do this ?

I agree with Ben that you shouldn’t really be using Sphinx for testing
your source.

But I also want to add that your command line is a too complicated way of
doing a simple thing. You could simply use “{interpreter} -m sphinx [args]”
instead.

-- 
Dmitry Shachnev

Attachment: signature.asc
Description: PGP signature


Reply to: