Path: csiph.com!news.mixmin.net!news.unit0.net!news.panservice.it!diesel.cu.mi.it!bofh.it!news.nic.it!robomod From: Ben Finney Newsgroups: linux.debian.maint.python Subject: Upstream build system, Sphinx autodoc, Python import path Date: Tue, 27 Sep 2016 10:50:01 +0200 Message-ID: X-Original-To: debian-python@lists.debian.org X-Mailbox-Line: From debian-python-request@lists.debian.org Tue Sep 27 08:49:07 2016 Old-Return-Path: X-Amavis-Spam-Status: No, score=-6.106 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, FOURLA=0.1, HEADER_FROM_DIFFERENT_DOMAINS=0.001, LDO_WHITELIST=-5, RDNS_NONE=0.793] autolearn=no autolearn_force=no X-Policyd-Weight: using cached result; rate: -6.1 X-Injected-Via-Gmane: http://gmane.org/ Lines: 34 MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.4 (gnu/linux) X-Public-Key-ID: 0xAC128405 X-Public-Key-Fingerprint: 517C F14B B2F3 98B0 CB35 4855 B8B2 4C06 AC12 8405 X-Public-Key-URL: http://www.benfinney.id.au/contact/bfinney-pubkey.asc X-Post-From: Ben Finney Cancel-Lock: sha1:dNQbH+NPbTmNoQ6YsrzFaXR/89A= X-Mailing-List: archive/latest/14248 List-ID: List-URL: List-Archive: https://lists.debian.org/msgid-search/85h991lodg.fsf@benfinney.id.au Approved: robomod@news.nic.it Organization: linux.* mail to news gateway Sender: robomod@news.nic.it X-Original-Date: Tue, 27 Sep 2016 18:48:27 +1000 X-Original-Message-ID: <85h991lodg.fsf@benfinney.id.au> X-Original-X-Complaints-To: usenet@blaine.gmane.org Xref: csiph.com linux.debian.maint.python:8906 Howdy all, What advice can we give to upstream for their build system, so that in a Debian build environment the Sphinx ‘autodoc’ can import upstream's code modules? Our wiki page on Library Style Guide advises the Debian packaging override the Python import path: If you need to build the Sphinx documentation (usually from .rst or .md files), add: override_dh_auto_build: dh_auto_build PYTHONPATH=. sphinx-build -N -bhtml docs/ build/html # HTML generator PYTHONPATH=. sphinx-build -N -bman docs/ build/man # Manpage generator This is surely not ideal, though. Better would be to not need ‘PYTHONPATH’ override at all, and just call the build program. What information do our build tools look for, and what variables are set, when running upstream's build system? What can we advise to upstream so their build system will work correctly in our build environment *without* that override in every Sphinx-using package? -- \ “For a sentimentalist is simply one who desires to have the | `\ luxury of an emotion without paying for it.” —Oscar Wilde, _De | _o__) Profundis_, 1897 | Ben Finney