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

Automatically build PDF documentation #26

Open
JanCBrammer opened this issue Jul 17, 2024 · 2 comments
Open

Automatically build PDF documentation #26

JanCBrammer opened this issue Jul 17, 2024 · 2 comments
Labels
CI / CD documentation Improvements or additions to documentation

Comments

@JanCBrammer
Copy link
Collaborator

JanCBrammer commented Jul 17, 2024

We're providing PDF documentation that's build from Markdown and DOCX files.
Currently, we're building it manually.
It could be build automatically as part of the release workflow, using pandoc.

Make sure links work in PDF (currently, links referring to other markdown files within the repo are broken).

@JanCBrammer JanCBrammer added the documentation Improvements or additions to documentation label Jul 17, 2024
@nbehrnd
Copy link

nbehrnd commented Jul 17, 2024

@JanCBrammer Given pandoc showcases examples of its use as a GitHub Action (example), this approach may indeed help to keep the content across the different output formats (.docx, .html, .pdf) in sync.

Frequently, I check .md files for syntax consistency with markdownlint. Similar to pylint for Python, the utility indicates the lines where a revision can improve the file altogether with a hint how to improve it. It isn't an active code reformatter (like black, or ruff) and thus some sed is necessary to incorporate the suggestions.

@JanCBrammer
Copy link
Collaborator Author

Thanks for the pointers @nbehrnd! Linting the docs seems super useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI / CD documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants