Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

masatake
Copy link
Member

Signed-off-by: Masatake YAMATO [email protected]

@AmaiKinono
Copy link
Member

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:

  • Don't let git ignore *.texi files or *.info files. I think keeping *.texi files are better since they are the "source code".
  • Do you know any git tricks that automatically run $ make info when commit?
  • Let make build them into the root directory of Citre. Or we can still build them into docs, but then we need to modify the Citre recipe on MELPA.

@AmaiKinono
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants