Skip to content

Split documentation generators into separate executable #1443

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.

Sign up for GitHub

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

Jump to bottom
Closed
kostmo opened this issue Aug 22, 2023 · 1 comment · Fixed by #1671
Closed

Split documentation generators into separate executable #1443

kostmo opened this issue Aug 22, 2023 · 1 comment · Fixed by #1671
Assignees
@kostmo
Labels
Z-Feature A new feature to be added to the game.

Comments

@kostmo
Copy link
Member

kostmo commented Aug 22, 2023

I've introduced pandoc as a dependency for #1436.

If the documentation generation was split off into a separate binary, say swarm-docs, then pandoc would not need to be compiled when just running swarm.
@kostmo kostmo added the Z-Feature A new feature to be added to the game. label Aug 22, 2023
@xsebek
Copy link
Member

xsebek commented Aug 23, 2023 •
edited
Loading

@kostmo could we make it a Stack/Cabal script? It seems the table generation does not depend on Swarm and we could run it as a one file script as long as Stack/Cabal provided the dependencies.

EDIT: I thought this would be harder if docs depended on Swarm version, but they can be another executable target in same repo and that should work fine.

@kostmo kostmo self-assigned this Dec 2, 2023
@kostmo kostmo mentioned this issue Dec 2, 2023
Merged
@mergify mergify bot closed this as completed in #1671 Dec 4, 2023
mergify bot pushed a commit that referenced this issue Dec 4, 2023
@kostmo
extract doc generator to separate executable (#1671)
b8d37a9 
Closes #1443.

Also added `-Wunused-packages` to clean up dependencies.

## Demo

This still works as usual:

    stack run

Output editor keywords:

    stack run swarm-docs -- editors --emacs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kostmo kostmo

Labels
Z-Feature A new feature to be added to the game.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

extract doc generator to separate executable swarm-game/swarm
2 participants
@kostmo @xsebek