Re: Texinfo to info command for cross-referencing custom manuals in docstrings
James Thomas <[email protected]> Fri, 22 May 2026 03:46:12 +0530
| Newsgroups | gmane.emacs.help |
|---|---|
| Message-ID | <[email protected]> |
Heime writes: > On Saturday, April 18th, 2026 at 5:31 AM, [email protected] > wrote: > >> Heime writes: >> >> > As I develop code, I continuously update its accompanying Texinfo >> > manual. I'd like an automated Emacs Lisp command that takes >> > antares.texi, >> > compiles it to an Info file antares.info, installs it properly, >> > and makes the nodes immediately available for cross-referencing >> > in my docstrings - like (antares)Rho Ophiuchi Cloud Complex >> > linking >> > directly to that node. >> > >> >> If someone does not provide a solution to your problem, here >> are some things you can try: >> >> 1. Look for a package/library that does what you want. >> Emacs comes with two archives in the user option >> ‘package-archives’. You could add to these two archives >> with any Emacs Lisp archives that you might find on the >> internet. One that many Emacs users commonly add is the >> "Melpa" archive, which comes in a "beta" archive or a >> "stable" archive. The "beta" archive has many more >> packages, but they are more experimental. >> >> M-x customize-option RET package-archives RET >> >> Add either https://stable.melpa.org/packages/ >> or https://melpa.org/packages/ >> >> 2. Look in the Emacs Wiki for an Emacs Lisp source file that >> does what you want, but which has not been turned into a >> package. See https://www.emacswiki.org/ >> >> 3. Some of what you want done is performed by one of many >> tools that create files when other files are changed. >> Probably the oldest and most-widely available is called >> ‘make’. GNU make is a GNU version of this tool. Check to >> see whether it is already on your operating system and, if >> not, see whether you can install it. If you can install it, >> then try the following expression to read the user manual >> for GNU make: (info "(make) Top") >> >> 4. Write a solution in Emacs Lisp. See the following >> section in the Emacs user manual >> (info "(emacs) Compilation") >> >> and the following chapter in the Texinfo user manual: >> (info "(texinfo) Creating and Installing Info Files") > > I would like to update the documentation and have it available > as I code. I currently am using bash script to produce the info > file. Would you suggest using make? > > Once the info is generated, how can I make an elisp command to > update the documentation? Could I put the info generated code > in the directory tree that I am currently working on? As long as it's always put in the same location, and you have that open in Info, 'C-x x g' ought to revert it. --