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.

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

Add end-user manual #337

Closed
3 tasks
nichtich opened this issue May 2, 2019 · 3 comments
Closed
3 tasks

Add end-user manual #337

nichtich opened this issue May 2, 2019 · 3 comments
Labels
documentation Provide sufficient documentation
Milestone
1.0.0

Comments

@nichtich
Copy link
Member

nichtich commented May 2, 2019 •
edited
Loading

With #336 we get an additional end-user manual in HTML and PDF.

  • improve layout, especially PDF
  • automatically run on travis
  • make public (link to the documents and/or include in Cocoda interface as Help)
@nichtich nichtich added the documentation Provide sufficient documentation label May 2, 2019
nichtich added a commit that referenced this issue May 2, 2019
@nichtich
Build user manual on travis-ci (#337)
d315772
nichtich added a commit that referenced this issue May 2, 2019
@nichtich
Build user manual on travis-ci (#337) (#338)
7c6c6b3
@nichtich
Copy link
Member Author

nichtich commented May 2, 2019

Build requires pandoc and can be run with npm run user-manual. The resulting files are docs/user-manual.{pdf,html}, not deployed at gh-pages yet.

@nichtich
Copy link
Member Author

nichtich commented May 2, 2019

Automatic build on travis is implemented in this branch Unfortunately it takes additional 40 seconds just because installation of latex modules via apt package takes so long. There is no simple method to cache apt package but installing LaTeX/XeTeX by hand could solve this because we can then cache the installation directory. See for instance https://shankarkulumani.com/2018/10/travis-and-latex.html

nichtich added a commit that referenced this issue May 2, 2019
@nichtich
Don't build user-manual on travis (#337)
8362237
@nichtich
Copy link
Member Author

We should limit this issue to HTML user manual and add PDF later on.

@nichtich nichtich added this to the 1.0.0 milestone Jun 27, 2019
This was referenced Jun 27, 2019
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Provide sufficient documentation
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
1 participant
@nichtich