Skip to content

Resolve "Missing pdf version of the manual"

Enrico Bothmann requested to merge 583-missing-pdf-version-of-the-manual into master

Description

Revert project name of the manual to "Sherpa Manual"

It was changed previously from "Sherpa Manual" to "Manual" when the logo was changed (the new version of the logo already contains the string "SHERPA", and the default sphinx theme for HTML output we use displays the project name immediately below the logo; hence, if the project name includes the word "Sherpa", this leads to an immediate repetition).

However, this change broke a link to the PDF version in the manual deployed to the project's GitLab pages. Also, the PDF version of the manual was then simply titled "Manual", which is not good.

Hence, we now revert this change, using the proper project name "Sherpa Manual" again. The problem with the immediate repetition of the word "Sherpa" in the HTML version is fixed by setting the HTML theme option "logo_name" to False, which removes the project name display below the logo entirely.

Test Plan

The automatic pipeline should fix the PDF link in the deployed pages. Clicking the link should display a PDF titled "Sherpa Manual".

Additional Checklist Items

  • I have updated documentation as needed
  • I considered if this should be cherry-picked/ported somewhere else (rel-2-x or master), and if yes, opened a corresponding issue or MR

Closes #583 (closed)

This should be cherry-picked to rel-3-0-x, as the fix for the PDF manual title is relevant for user builds of Sherpa.

Edited by Enrico Bothmann

Merge request reports