Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUILD: Add build flags to download the manual from RTD #2904

Open
wants to merge 3 commits into
base: master
from

Conversation

@Mataniko
Copy link
Contributor

@Mataniko Mataniko commented Apr 1, 2021

This PR adds a new build target "manual" that will grab the manual from RTD in PDF format.

By default, we will grab "latest", but if we are tagging for release it will use the semantic version number. (We will need to have the version tagged and a doc version available in RTD for this to work)

Alternatively, a new option was added to configure to allow the user to specify the exact version of the manual they'd want to download.

Not super confident in make, so let me know if you see anything wrong. I'm also not entirely sure where to add rules that will package the manual in the various distribution packaging, so please let me know in the comments.

The current PDF size is around 2.7 MB.

@criezy
Copy link
Member

@criezy criezy commented Apr 2, 2021

I'm also not entirely sure where to add rules that will package the manual in the various distribution packaging, so please let me know in the comments.

For macOS it's sufficient to add it to DIST_FILES_DOCS.
There is however a bit more work to do in appmenu_osx.mm to add it to the Help menu (possibly as a replacement to the README; I am not sure we need both). I can do that if you want, but you are off course welcome to look at this yourself.

@Mataniko
Copy link
Contributor Author

@Mataniko Mataniko commented Apr 2, 2021

Looks like we already have "Open Manual" for macOS, and in that case we can just open the actual website which looks much better than the local copy

@criezy
Copy link
Member

@criezy criezy commented Apr 2, 2021

Looks like we already have "Open Manual" for macOS, and in that case we can just open the actual website which looks much better than the local copy

I forgot, but we indeed had a link to the old manual.
I am wondering if it would not be better to open the local PDF version though as:

  • it will work even without internet access
  • it will be in sync with the version of ScummVM being used

If we decide we prefer the website there is not much sense to distribute the PDF with ScummVM (at least on macOS where the documents are hidden inside the ScummVM.app bundle, and nobody is going to look there).

@lephilousophe
Copy link
Member

@lephilousophe lephilousophe commented Apr 4, 2021

Isn't it possible to generate the PDF locally instead of downloading it?

@Mataniko
Copy link
Contributor Author

@Mataniko Mataniko commented Apr 4, 2021

It's possible - but it would add a ton of dependencies for making a release plus add several minutes of build time.

configure Outdated Show resolved Hide resolved
configure Show resolved Hide resolved
configure Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants