by default build HTML doc without PDF links

[sagetrac-mvngu]

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. attachment: trac-10811_Makefile.patch
2. attachment: trac-10811_docbuild.patch

Component: documentation

Author: Minh Van Nguyen

Reviewer: Mariah Lenox

Merged: sage-4.7.1.alpha3

Issue created by migration from https://trac.sagemath.org/ticket/10811

[sagetrac-mvngu]

Attachment: Makefile.gz

[sagetrac-mvngu]

Author: Minh Van Nguyen

[sagetrac-mvngu]

comment:1

Attachment: Makefile.diff.gz

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.

[kcrisman]

comment:2

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.

[sagetrac-mvngu]

comment:3

Attachment: trac-10811_docbuild.patch.gz

[sagetrac-mvngu]

comment:4

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.

[sagetrac-mariah]

comment:5

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.

[sagetrac-mariah]

Reviewer: Mariah Lenox

[jdemeyer]

comment:6

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

[sagetrac-mariah]

Attachment: trac-10811_Makefile.patch.gz

[jdemeyer]

Merged: sage-4.7.1.alpha3