Opened 10 years ago

Closed 10 years ago

#10811 closed defect (fixed)

by default build HTML doc without PDF links

Reported by: mvngu Owned by: mvngu
Priority: major Milestone: sage-4.7.1
Component: documentation Keywords:
Cc: Merged in: sage-4.7.1.alpha3
Authors: Minh Van Nguyen Reviewers: Mariah Lenox
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by mariah)

The Makefile currently (Sage 4.6.2.rc0) builds the HTML document with links to the PDF version. But if only the HTML document is built, then the generated links would be broken links. This can be fixed by getting Makefile to by default build the HTML documentation without linking to the PDF version. Also, the Makefile should contain instructions on how to build both the HTML and PDF versions and have the HTML version link to the PDF version.

See this sage-devel thread for background information.

Apply:

  1. trac-10811_Makefile.patch
  2. trac-10811_docbuild.patch

Attachments (4)

Makefile (5.1 KB) - added by mvngu 10 years ago.
Makefile.diff (1.2 KB) - added by mvngu 10 years ago.
trac-10811_docbuild.patch (2.5 KB) - added by mvngu 10 years ago.
trac-10811_Makefile.patch (1.5 KB) - added by mariah 10 years ago.

Download all attachments as: .zip

Change History (12)

Changed 10 years ago by mvngu

Changed 10 years ago by mvngu

comment:1 Changed 10 years ago by mvngu

  • Authors set to Minh Van Nguyen
  • Description modified (diff)
  • Status changed from new to needs_review

Only apply Makefile; i.e. replace the current Makefile with the updated Makefile on this ticket. The file Makefile.diff serves only to show the proposed changes.

comment:2 follow-up: Changed 10 years ago by kcrisman

Hmm, but who reads Makefiles for documentation? Maybe adding something elsewhere in the documentation to specifically mention this - and the (apparently?) change in default behavior - would make it more effective.

Changed 10 years ago by mvngu

comment:3 Changed 10 years ago by mvngu

  • Description modified (diff)

comment:4 in reply to: ↑ 2 Changed 10 years ago by mvngu

Replying to kcrisman:

Maybe adding something elsewhere in the documentation to specifically mention this - and the (apparently?) change in default behavior - would make it more effective.

Done. See the additional patch.

comment:5 Changed 10 years ago by mariah

  • Reviewers set to Mariah Lenox
  • Status changed from needs_review to positive_review

sage-4.7.rc2 built with this ticket's Makefile correctly causes HTML documentation to be built without PDF links. Documentation patch looks good. Positive review.

comment:6 Changed 10 years ago by jdemeyer

  • Milestone changed from sage-4.7 to sage-4.7.1
  • Status changed from positive_review to needs_work

Please add a proper hg changeset for the Makefile instead of a simple diff.

Changed 10 years ago by mariah

comment:7 Changed 10 years ago by mariah

  • Description modified (diff)
  • Status changed from needs_work to positive_review

comment:8 Changed 10 years ago by jdemeyer

  • Merged in set to sage-4.7.1.alpha3
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.