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

Add end-user manual in PDF #435

Closed
2 of 3 tasks
nichtich opened this issue Jun 28, 2019 · 3 comments
Closed
2 of 3 tasks

Add end-user manual in PDF #435

nichtich opened this issue Jun 28, 2019 · 3 comments
Labels
documentation Provide sufficient documentation
Milestone

Comments

@nichtich
Copy link
Member

nichtich commented Jun 28, 2019

This is already implemented (run make pdf in docs/*/), but

@nichtich nichtich added the documentation Provide sufficient documentation label Jun 28, 2019
@nichtich nichtich added this to the 2.0.0 milestone Jun 28, 2019
@nichtich nichtich modified the milestones: 2.0.0, 1.3.0 Nov 6, 2019
@nichtich
Copy link
Member Author

nichtich commented Nov 6, 2019

We could make the travis job only run on releases although this adds another fragile step to the release process. At least Pandoc 2.7 is required which may require different setup at travis.

German end-user manual is already finished, see https://coli-conc.gbv.de/cocoda/dev/user-manual-de.html.

@nichtich
Copy link
Member Author

nichtich commented Nov 11, 2019

The PDF manual is only build if the docs/ folder was modified.

  • This should be extended to tagged commit (releases) and to changes in the public/img/ folder.
  • Installation of LaTeX could be cached as described here to save 30s-60s build time
  • pdfbook is not available at travis (should be part of texlive package pdfjam)

@nichtich
Copy link
Member Author

I've set up cached LaTeX installation on the travis branch. The PDF should be build when the docs/ folder was changed and on tagged commits. It looks like there is a new cache for each tag (?), so releases would need longer. Build still fails because pdfbook is missing (should be part of texlive package pdfjam)

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

No branches or pull requests

1 participant