Opened 3 years ago

Closed 12 months ago

#510 closed enhancement (fixed)

Build PDF documentation along with HTML

Reported by: butler Owned by: wojciech
Priority: major Milestone: SasView 4.2.0
Component: SasView Keywords:
Cc: Work Package: SasView Documentation

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)

Change History (10)

comment:1 Changed 3 years ago by butler

  • Milestone changed from SasView 4.0.0 to SasView Next Release +1
  • Priority changed from critical to major

comment:2 Changed 3 years ago by butler

  • Milestone changed from SasView Next Release +1 to SasView 4.0.0

comment:3 Changed 3 years ago by smk78

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.

comment:4 Changed 2 years ago by butler

  • Milestone changed from SasView 4.0.0 to SasView Next Release +1

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

comment:5 Changed 2 years ago by ajj

  • Owner set to ajj
  • Status changed from new to assigned

comment:6 Changed 19 months ago by smk78

  • Milestone changed from SasView Next Release +1 to SasView 4.2.0
  • Owner changed from ajj to wojciech

comment:7 Changed 19 months ago by wojciech

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

comment:8 Changed 19 months ago by smk78

Also see #934

comment:9 Changed 15 months ago by wojciech

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

comment:10 Changed 12 months ago by butler

  • Resolution set to fixed
  • Status changed from assigned to closed

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.

Note: See TracTickets for help on using tickets.