Project

General

Profile

Bug #2783

PDF reference manual suggestions

Added by Mark Abraham 12 months ago. Updated 11 months ago.

Status:
Closed
Priority:
Normal
Assignee:
Category:
documentation
Target version:
Affected version - extra info:
Affected version:
Difficulty:
uncategorized
Close

Description

Currently the main TOC has only one level, which works well for the HTML output, but not for the PDF output. Perhaps we need a different top-level rst file in the two cases.

Also, 60 pages of release notes probably isn't needed; prefer a comment that the release notes are available online.

Associated revisions

Revision 5f61a6a5 (diff)
Added by Paul Bauer 11 months ago

Change toctree depth in PDF manual

It doesn't seem to be possible to set different toctree depths for the
HTML and PDF versions of the manual in Sphinx itself. To work around
this, I added the explicit depth to the LaTeX preamble.

Refs #2783

Change-Id: I74e00b339a014060567a9fd6aa875e7047165e66

Revision eaacd177 (diff)
Added by Paul Bauer 11 months ago

Make release notes html only

Refs #2783

Change-Id: Ifa2e5486e9f3d4be5369bd82f4f858c1ea54e22e

History

#1 Updated by Paul Bauer 12 months ago

  • Assignee set to Paul Bauer

The toctree issue is likely to do with the way Sphinx handles the generation of the LaTeX input file, I can check if I can hack something together there.
The release notes can be removed from the pdf form.

#2 Updated by Gerrit Code Review Bot 12 months ago

Gerrit received a related patchset '1' for Issue #2783.
Uploader: Paul Bauer ()
Change-Id: gromacs~release-2019~I74e00b339a014060567a9fd6aa875e7047165e66
Gerrit URL: https://gerrit.gromacs.org/8772

#3 Updated by Gerrit Code Review Bot 12 months ago

Gerrit received a related patchset '1' for Issue #2783.
Uploader: Paul Bauer ()
Change-Id: gromacs~release-2019~Ifa2e5486e9f3d4be5369bd82f4f858c1ea54e22e
Gerrit URL: https://gerrit.gromacs.org/8773

#4 Updated by Paul Bauer 12 months ago

  • Status changed from New to Fix uploaded

#5 Updated by Mark Abraham 11 months ago

  • Status changed from Fix uploaded to Resolved
  • Target version changed from 2019 to 2019-rc1

#6 Updated by Mark Abraham 11 months ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF