Re: how to build sphinx doc when there is extension
Hi,
On Tue, Aug 30, 2016 at 07:14:53AM +, 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
signature.asc
Description: PGP signature
Re: how to build sphinx doc when there is extension
PICCA Frederic-Emmanuel writes: > > how about doing it outside pybuild? Do you really need to build it for > > each interpreter / version? > > > It is a sort of unit test during the build that auto-doc works for all > versions of the interpreter. You're only installing one version of the documentation, though. Correct? If so, this package is not a good place to do the test you describe. > th eunit test is > try to import all the modules provided by a packages. That isn't a good fit for “build the documentation”. It also does not explain why you try to do it with every interpreter. > Is there something whcih can be automatise at the autodep8 level for > python ? You can start with the tests I have in ‘python-coverage’ https://sources.debian.net/src/python-coverage/4.2%2Bdfsg.1-1/debian/tests/> which allows you to specify the module names to test. -- \ “Education is learning what you didn't even know you didn't | `\ know.” —Daniel J. Boorstin, historian, 1914–2004 | _o__) | Ben Finney
Re: how to build sphinx doc when there is extension
[PICCA Frederic-Emmanuel, 2016-08-30]
> 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 ?
how about doing it outside pybuild? Do you really need to build it for
each interpreter / version?
If you need the build dir:
override_dh_sphinxdoc:
ifeq (,$(findstring nodocs, $(DEB_BUILD_OPTIONS)))
PYTHONPATH=$(pybuild --system=custom -i python3 --build
--build-args="echo {build_dir}") \
cd doc && http_proxy='127.0.0.1:9' sphinx-build -N -bhtml source
build/html
dh_installdocs "doc/build/html" -p python-pyfai-doc
dh_sphinxdoc -O--buildsystem=pybuild
endif
--
Piotr Ożarowski Debian GNU/Linux Developer
www.ozarowski.pl www.griffith.cc www.debian.org
GPG Fingerprint: 1D2F A898 58DA AF62 1786 2DF7 AEF6 F1A2 A745 7645
how to build sphinx doc when there is extension
Hello
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 ?
thanks
Frederic
