unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Philip Kaludercic <philipk@posteo.net>
To: "Kjartan Óli Ágústsson" <kjartanoli@outlook.com>
Cc: "emacs-devel@gnu.org" <emacs-devel@gnu.org>
Subject: Re: Manuals for GNU ELPA packages
Date: Tue, 26 Dec 2023 17:17:03 +0000	[thread overview]
Message-ID: <87h6k4sx2o.fsf@posteo.net> (raw)
In-Reply-To: <AS8PR02MB7173A9C811AC261DE1CDCBFEDF98A@AS8PR02MB7173.eurprd02.prod.outlook.com> ("Kjartan Óli Ágústsson"'s message of "Tue, 26 Dec 2023 13:44:05 +0000")

[-- Attachment #1: Type: text/plain, Size: 584 bytes --]

Kjartan Óli Ágústsson <kjartanoli@outlook.com> writes:

> Some time ago my calibre package
> (https://elpa.gnu.org/packages/calibre.html) was added to GNU ELPA.
> Shortly after that I made my first attempt to write a Texinfo manual for
> the package.  When I look at the tarball downloaded from ELPA I see the
> texi files are there but there are no info files.  Does the ELPA package
> specification need to be updated, or did I do something wrong when
> adding the manual to my repository?

Yes, the package specification needs a new :doc attribute, something
like


[-- Attachment #2: Type: text/plain, Size: 543 bytes --]

diff --git a/elpa-packages b/elpa-packages
index 858948422f..8faa74d12b 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -123,7 +123,8 @@
  ;;                      :doc "cc-mode.texi"))
  (buildbot		:url "https://g.ypei.me/buildbot.el.git"
   :readme "README.org")
- (calibre               :url "https://git.disroot.org/kjartanoli/calibre.el")
+ (calibre               :url "https://git.disroot.org/kjartanoli/calibre.el"
+  :doc "doc/calibre.tex")
  (cape			:url "https://github.com/minad/cape"
   :doc "README.org"
   :news "CHANGELOG.org"

[-- Attachment #3: Type: text/plain, Size: 301 bytes --]


Just note that the file extension .tex is wrong here, since this is not
a regular TeX or LaTeX file.  If you rename it to .texi and we then
update the specification, then the documentation should be packaged in
the tarball and also appear online under
https://elpa.gnu.org/packages/doc/calibre.html.

  reply	other threads:[~2023-12-26 17:17 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-26 13:44 Manuals for GNU ELPA packages Kjartan Óli Ágústsson
2023-12-26 17:17 ` Philip Kaludercic [this message]
2023-12-27  8:41   ` Michael Albinus
2023-12-27 13:47     ` Philip Kaludercic
2024-02-26 10:49     ` Philip Kaludercic
2024-02-26 13:04       ` Stefan Monnier
2024-02-26 14:05         ` Philip Kaludercic
2024-02-26 15:03       ` Stefan Monnier
2024-02-26 15:27         ` Philip Kaludercic
2024-02-26 16:15           ` Stefan Monnier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87h6k4sx2o.fsf@posteo.net \
    --to=philipk@posteo.net \
    --cc=emacs-devel@gnu.org \
    --cc=kjartanoli@outlook.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).