emacs-devel
[Top][All Lists]
Advanced

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

Re: Manuals for GNU ELPA packages


From: Philip Kaludercic
Subject: Re: Manuals for GNU ELPA packages
Date: Tue, 26 Dec 2023 17:17:03 +0000

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

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"
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 via email to

[Prev in Thread] Current Thread [Next in Thread]