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

Re: nodoc solution HOWTO -- Avoid building Sphinx documentation on request (was: Bug#905750: RFS: elpy/1.23.0-1)



Hi Niels,

On Wed, Sep 05, 2018 at 05:45:00AM +0000, Niels Thykier wrote:
[...]
> Rather, I think there is a typo in changes.
> 
> > ---
> >  debian/changelog | 6 ++++++
> >  debian/control   | 4 ++--
> >  debian/rules     | 8 +++++++-
> >  3 files changed, 15 insertions(+), 3 deletions(-)
> > 
> > [...]
> > diff --git a/debian/rules b/debian/rules
> > index a9d70b4..bd4c218 100755
> > --- a/debian/rules
> > +++ b/debian/rules
> > @@ -11,7 +11,13 @@ export LC_ALL
> >  # docs are not generated without this override
> >  override_dh_auto_build:
> >  	dh_auto_build
> > -	PYTHONPATH=. sphinx-build -N -bman docs/ build/man # Manpage generator
> > +# support the nodoc build profile
> > +ifneq ($(filter nodocs,$(DEB_BUILD_PROFILES)),)
>                    ^^^^^^
> 
> nodocs != nodoc

Thank you for pointing this out, you're right, my mistake :-) When I
fixed it, I also discovered that dh_sphinxdoc doesn't detect that nodoc
is active, so worked around it and filed #908078.  For now, here is
the working solution (including dh_sphinxdoc workaround) sans typo.


--- a/debian/control
+++ b/debian/control
@@ -27,8 +27,8 @@ Build-Depends: debhelper (>= 11~)
              , python3-mock <!nocheck>
              , python3-nose <!nocheck>
              , python3-pip <!nocheck>
-             , python3-sphinx
-             , texinfo
+             , python3-sphinx <!nodoc>
+             , texinfo <!nodoc>
 Standards-Version: 4.2.1
 Vcs-Browser: https://salsa.debian.org/emacsen-team/elpy
 Vcs-Git: https://salsa.debian.org/emacsen-team/elpy.git
diff --git a/debian/rules b/debian/rules
index a9d70b4..47f597b 100755
--- a/debian/rules
+++ b/debian/rules
@@ -6,12 +6,23 @@ LC_ALL := C.UTF-8
 export LC_ALL
 
 %:
+ifneq ($(filter nodoc,$(DEB_BUILD_PROFILES)),)
+       echo -e "\nnodoc profile enabled, building without sphinxdoc..\n"
+       dh $@ --with elpa,python3 --buildsystem=pybuild
+else
        dh $@ --with elpa,python3,sphinxdoc --buildsystem=pybuild
+endif
 
 # docs are not generated without this override
 override_dh_auto_build:
        dh_auto_build
-       PYTHONPATH=. sphinx-build -N -bman docs/ build/man # Manpage generator
+# support the nodoc build profile
+ifneq ($(filter nodoc,$(DEB_BUILD_PROFILES)),)
+       echo -e "\nnodoc build profile enabled, therefor not building docs.\n"
+else
+       PYTHONPATH=. sphinx-build -N -bman docs/ build/man
        PYTHONPATH=. sphinx-build -N -btexinfo docs/ build/info
        makeinfo --no-split build/info/Elpy.texi -o build/info/elpy.info
        cat NEWS.rst debian/local-var-snippet > build/NEWS
+endif


Sincerely,
Nicholas

Attachment: signature.asc
Description: PGP signature


Reply to: