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

Build PDF documentation along with HTML (Trac #510) #643

Closed
butlerpd opened this issue Mar 30, 2019 · 10 comments
Closed

Build PDF documentation along with HTML (Trac #510) #643

butlerpd opened this issue Mar 30, 2019 · 10 comments
Assignees
Labels
Documentation Concerns documentation Enhancement Feature requests and/or general improvements Major Big change in the code or important change in behaviour
Milestone

Comments

@butlerpd
Copy link
Member

butlerpd commented Mar 30, 2019

Sphinx make file needs to be edited to build PDFs as well as HTML for offline use. Note that expectation is to have tutorials delivered in the same way (PDF and HTML bundled with !SasView and on the web page)

Migrated from http://trac.sasview.org/ticket/510

{
    "status": "closed",
    "changetime": "2017-10-27T13:36:11",
    "_ts": "2017-10-27 13:36:11.354120+00:00",
    "description": "Sphinx make file needs to be edited to build PDFs as well as HTML for offline use. Note that expectation is to have tutorials delivered in the same way (PDF and HTML bundled with !SasView and on the web page)",
    "reporter": "butler",
    "cc": "",
    "resolution": "fixed",
    "workpackage": "SasView Documentation",
    "time": "2016-03-15T16:52:49",
    "component": "SasView",
    "summary": "Build PDF documentation along with HTML",
    "priority": "major",
    "keywords": "",
    "milestone": "SasView 4.2.0",
    "owner": "wojciech",
    "type": "enhancement"
}
@butlerpd butlerpd added this to the SasView 4.2.0 milestone Mar 30, 2019
@butlerpd butlerpd added Enhancement Feature requests and/or general improvements Incomplete Migration Major Big change in the code or important change in behaviour Documentation Concerns documentation and removed Incomplete Migration labels Mar 30, 2019
@butlerpd
Copy link
Member Author

Trac update at 2016/03/20 23:05:13:

  • butler changed milestone from "SasView 4.0.0" to "SasView Next Release +1"
  • butler changed priority from "critical" to "major"

@butlerpd
Copy link
Member Author

Trac update at 2016/03/20 23:21:47: butler changed milestone from "SasView Next Release +1" to "SasView 4.0.0"

@smk78
Copy link
Contributor

smk78 commented Mar 30, 2019

Trac update at 2016/03/20 23:28:04: smk78 commented:

Make file is already set to make pdf. But pdf is generated from a latex make first and this requires the build machine to have a TeK installation. TeK is not currently on DMSC build servers.

@butlerpd
Copy link
Member Author

Trac update at 2016/06/19 16:40:00:

  • butler commented:

Yet another thing that should be relatively straightforward to finish but not vital for 4.0 and give the resources and amount of work left for 4.0 sadly need to move to +1

  • butler changed milestone from "SasView 4.0.0" to "SasView Next Release +1"

@ajj
Copy link
Member

ajj commented Mar 30, 2019

Trac update at 2016/10/07 19:45:59:

  • ajj changed owner from "" to "ajj"
  • ajj changed status from "new" to "assigned"

@smk78
Copy link
Contributor

smk78 commented Mar 30, 2019

Trac update at 2017/04/05 09:25:01:

  • smk78 changed milestone from "SasView Next Release +1" to "SasView 4.2.0"
  • smk78 changed owner from "ajj" to "wojciech"

@wpotrzebowski
Copy link
Contributor

Trac update at 2017/04/05 15:31:47: wojciech commented:

This turned out to be complicated there are two ways to approach this.

  1. Install rst2pdf and modify build_sphinx.py to create pdf
  2. Modify build_sphinx.py to create latex file and then use pdflatex to generate pdf.

The issue with 1) is that it doesn't really work 2) requires all the images converted to png (both gif and bmp), which are quite many

@smk78
Copy link
Contributor

smk78 commented Mar 30, 2019

Trac update at 2017/04/08 14:59:20: smk78 commented:

Also see #1014

@wpotrzebowski
Copy link
Contributor

Trac update at 2017/07/24 05:14:46: wojciech commented:

Progressed much with this during last code camp but need to finish off.

@butlerpd
Copy link
Member Author

Trac update at 2017/10/27 13:36:11:

  • butler commented:

This now works. PDF is built only on Ubuntu build server. Artifact needs to be copied to wherever we want it -- the website for now. Will add this instruction to wiki. Can now close this ticket.

  • butler changed resolution from "" to "fixed"
  • butler changed status from "assigned" to "closed"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Concerns documentation Enhancement Feature requests and/or general improvements Major Big change in the code or important change in behaviour
Projects
None yet
Development

No branches or pull requests

4 participants