Groups > linux.debian.maint.python > #8917

Re: Upstream build system, Sphinx autodoc, Python import path

Path	csiph.com!news.mixmin.net!aioe.org!bofh.it!news.nic.it!robomod
From	Florent Rougon <f.rougon@free.fr>
Newsgroups	linux.debian.maint.python
Subject	Re: Upstream build system, Sphinx autodoc, Python import path
Date	Fri, 30 Sep 2016 08:20:02 +0200
Message-ID	<smZkS-6ys-19@gated-at.bofh.it> (permalink)
References	<slWfn-7h7-15@gated-at.bofh.it> <smRdE-15L-19@gated-at.bofh.it> <smWdj-4me-5@gated-at.bofh.it>
X-Mailbox-Line	From debian-python-request@lists.debian.org Fri Sep 30 06:14:04 2016
Old-Return-Path	<f.rougon@free.fr>
X-Amavis-Spam-Status	No, score=-6.699 tagged_above=-10000 required=5.3 tests=[BAYES_00=-2, DIGITS_LETTERS=1, FREEMAIL_FROM=0.001, LDO_WHITELIST=-5, MURPHY_DRUGS_REL8=0.02, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01] autolearn=ham autolearn_force=no
Mail-Followup-To	debian-python@lists.debian.org
User-Agent	Gnus/5.13 (Gnus v5.13) Emacs/24.5 (gnu/linux)
MIME-Version	1.0
Content-Type	text/plain
X-Mailing-List	<debian-python@lists.debian.org> archive/latest/14259
List-ID	<debian-python.lists.debian.org>
List-URL	<https://lists.debian.org/debian-python/>
List-Archive	https://lists.debian.org/msgid-search/87ponlkj8h.fsf@frougon.crabdance.com
Approved	robomod@news.nic.it
Lines	36
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Fri, 30 Sep 2016 08:13:50 +0200
X-Original-Message-ID	<87ponlkj8h.fsf@frougon.crabdance.com>
X-Original-References	<85h991lodg.fsf@benfinney.id.au> <8f17303d-4521-05e5-5795-7b1aa4bd7d6d@debian.org> <87k2duxfzd.fsf@vostro.rath.org>
Xref	csiph.com linux.debian.maint.python:8917

Show key headers only | View raw

Or use the following alternative, which lets the user browse the
documentation offline.

$ cat debian/patches/use-local-python3-doc-for-cross-references
>From f519a948173bfd4e9700a4ebc60bc54bf3455018 Mon Sep 17 00:00:00 2001
From: Florent Rougon <f.rougon@free.fr>
Date: Thu, 8 Oct 2015 13:28:35 -0700
Subject: Use local doc from python3-doc for cross references

Forwarded: not-needed
Last-Update: 2014-10-17

Patch-Name: use-local-python3-doc-for-cross-references
---
 doc/conf.py | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/conf.py b/doc/conf.py
index 728397d..18461c9 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -35,7 +35,8 @@ extensions = [
     'sphinx.ext.viewcode',
 ]
 
-intersphinx_mapping = {'python': ('http://docs.python.org/3', None)}
+intersphinx_mapping = {'python': ('file:///usr/share/doc/python3/html',
+                                  '/usr/share/doc/python3/html/objects.inv')}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

Then put python3-doc in B-D and Suggests or so.

-- 
Florent

Thread

Upstream build system, Sphinx autodoc, Python import path Ben Finney <ben+debian@benfinney.id.au> - 2016-09-27 10:50 +0200
  Re: Upstream build system, Sphinx autodoc, Python import path Thomas Goirand <zigo@debian.org> - 2016-09-29 23:30 +0200
    Re: Upstream build system, Sphinx autodoc, Python import path Dmitry Shachnev <mitya57@debian.org> - 2016-09-30 08:50 +0200
  Re: Upstream build system, Sphinx autodoc, Python import path Thomas Goirand <zigo@debian.org> - 2016-09-29 23:40 +0200
    Re: Upstream build system, Sphinx autodoc, Python import path Barry Warsaw <barry@debian.org> - 2016-09-30 00:00 +0200
    Re: Upstream build system, Sphinx autodoc, Python import path Nikolaus Rath <Nikolaus@rath.org> - 2016-09-30 05:00 +0200
      Re: Upstream build system, Sphinx autodoc, Python import path Florent Rougon <f.rougon@free.fr> - 2016-09-30 08:20 +0200
        Re: Upstream build system, Sphinx autodoc, Python import path Thomas Goirand <zigo@debian.org> - 2016-09-30 12:20 +0200
        Re: Upstream build system, Sphinx autodoc, Python import path Nikolaus Rath <Nikolaus@rath.org> - 2016-09-30 23:20 +0200

csiph-web