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

[craftedv2beta] New tooling for exporting info documentation #306

Merged
merged 4 commits into from
Jul 24, 2023

Conversation

jvdydev
Copy link
Contributor

@jvdydev jvdydev commented Jul 22, 2023

Addressing #166.

Adds crafted-docs.el and Makefile to docs/:

  • interactive function crafted-docs-export to export info file
  • Makefile (make docs) to export info file
  • optional variable to utilize crafted-emacs-home variable for finding the path to docs/

Updates CONTRIBUTING.org accordingly.

jvdydev added 3 commits July 22, 2023 14:39
Loading crafted-docs.el provides an interactive function
"crafted-docs-export-info" which runs a separate Emacs instance for exporting.

Alternatively can be called from the command-line using:
emacs -Q --script crafted-docs.el -f crafted-docs-export-info
or with the Makefile by running 'make docs'.
- discourage use of org-export functionality
- Explain interactive and make style usage (and requirements).
@jvdydev
Copy link
Contributor Author

jvdydev commented Jul 22, 2023

This is basically ready for review/merge, however I was wondering if we should include a link on how to add things to $PATH.

I don't think it's necessary for Linux as Emacs is most likely on PATH, but I couldn't find official Microsoft documentation for Windows (hence I didn't link anything for now).

@jeffbowman
Copy link
Contributor

Busy weekend, sorry for the late reply, I'll review this tomorrow (Monday 24 July 2023).

Copy link
Contributor

@jeffbowman jeffbowman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Minor suggestion to use file-directory-p instead.

docs/crafted-docs.el Outdated Show resolved Hide resolved
@jvdydev jvdydev requested a review from jeffbowman July 24, 2023 20:03
@jeffbowman jeffbowman merged commit e32ad58 into SystemCrafters:craftedv2beta Jul 24, 2023
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