From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: link info/html files from the GNU ELPA package page Date: Tue, 24 Aug 2021 16:44:37 -0400 Message-ID: References: <86eeaqbo4e.fsf@stephe-leake.org> <861r6mb7ti.fsf@stephe-leake.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="26951"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: emacs-devel To: Stephen Leake Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Aug 24 22:45:45 2021 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1mIdIm-0006oT-MI for ged-emacs-devel@m.gmane-mx.org; Tue, 24 Aug 2021 22:45:45 +0200 Original-Received: from localhost ([::1]:54008 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIdIl-000895-9R for ged-emacs-devel@m.gmane-mx.org; Tue, 24 Aug 2021 16:45:43 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:47816) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIdHs-0007T3-NU for emacs-devel@gnu.org; Tue, 24 Aug 2021 16:44:49 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:41830) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIdHp-0002VJ-Dt for emacs-devel@gnu.org; Tue, 24 Aug 2021 16:44:47 -0400 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id D3995440F96; Tue, 24 Aug 2021 16:44:42 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 17483440318; Tue, 24 Aug 2021 16:44:38 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1629837878; bh=Iv7efgpMtPGz4DplEGyITgpXyh6Iyuib/2xUNCgmZhA=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=R/+oJwNuJfPuZ37dig1hDKjR4omccNr7GXVrXHRnx8poAQOTKqiAeQ6kNUqgdhMgK DexPVrLQpvpCmUAnqJOtxJTjvkHKkGOUgZkMNzwJxW5AXwyRNFoYTLF+Yh0+b5kJ2q exSmJtDfk3sbC6kOEmEe2l7mrbXGjK8JnAptRZ/SQvH5MM4S1KNiMueWyo7LJD5Ks8 aE+xoh7OuzGTRUwdRsWg8iXxqrxMdW64MJl5u+GgfupvYZEXDsBTHtZLGOL0/qTSLF uVc+8HHqpLcz157gkhvHKcSwt9uImZ1T+hZp1GpshNK0mrRhOjwHDe9PFqJV1BKXZU ywsujAKQnsjvg== Original-Received: from alfajor (unknown [104.247.244.135]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id DF98712034A; Tue, 24 Aug 2021 16:44:37 -0400 (EDT) In-Reply-To: <861r6mb7ti.fsf@stephe-leake.org> (Stephen Leake's message of "Sat, 21 Aug 2021 18:13:13 -0700") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:272924 Archived-At: >>> How would I go about adding html files from the :doc entry for wisi in >>> elpa/elpa-packages to https://elpa.gnu.org/packages/wisi.html> ? > I links to them, so users can read the user manuals from the ELPA > page. That also means the ELPA server needs to store the actual doc > files somewhere accessible, not just in the package tarball. [ Not completely sure what you wanted to write for "I links", but I think the overall intent was clear enough. ] Yes, that would make sense. >>> I assume there's some script/elisp in elpa/admin that generates >>> that page? >> It's in `elpa-admin.el`, e.g. around `elpaa--html-make-pkg`. > Ok. So that could add a line for ada-mode: > > docs: ada-mode, gpr-mode `ada-mode.html` would link back to the package's description page I think, but we could have relative links like `doc/ada-mode/`. > Instead of just the file name, maybe we could pull the doc title from > the texinfo file somehow? That would be swell ;-) > And somewhere in elpaa--make-one-package it would have to save the doc > files somewhere, instead of deleting them after building the tarball. Actually, we would first have to generate HTML versions of the doc, so it will take a bit more effort, but yes, it can probably be done somewhere near the end of `elpaa--make-one-tarball-1` and the somewhere would presumably be relative to the directory of `tarball`, e.g. specified via a global like (defvar elpa--doc-subdirectory "doc/"), controllable by `elpa-config` with a nil value preventing the creation of that doc. Stefan