universal-ctags / citre

A superior code reading & auto-completion tool with pluggable backends.
GNU General Public License v3.0
326 stars 26 forks source link

docs, enh: add a target for generating .info files #76

Open masatake opened 3 years ago

masatake commented 3 years ago

Signed-off-by: Masatake YAMATO yamato@redhat.com

AmaiKinono commented 3 years ago

Thanks!

I can confirm it works well.

If a user manually installed Citre, they can add the docs dir to Info-directory-list to visit them by C-h i. However, I'm thinking for those who installed Citre use a package manager, like MELPA or straight.el (I use the latter one).

For them to automatically install the info files, we need to keep at least the *.texi files in the source tree. This is clear to see the default files used by MELPA to build the package:

 ("*.el" "*.el.in" "dir"
   "*.info" "*.texi" "*.texinfo"
   "doc/dir" "doc/*.info" "doc/*.texi" "doc/*.texinfo"
   (:exclude ".dir-locals.el" "test.el" "tests.el" "*-test.el" "*-tests.el"))

straight.el uses the same set of default files, as far as I know.

So what we need to do is:

AmaiKinono commented 3 years ago

Also, I don't know if it can be done with texinfo: Can we convert README.md into a texinfo file, and the links in it (to those manuals) still work?

README.md covers most useful info users, and is often mentioned in user manuals.