Build pdf, make release v1.0.0 for OBPS system

[soerenthomsen]

The plan is now 1) Build a pdf locally 2) Make a GitHub release (zip file) of this repo 3) Submit the pdf + zip file to the OBPS system 4) Link the doi provided by OBPS to the GitHub release

Does it make sense?

_Originally posted by @soerenthomsen in https://github.com/OceanGlidersCommunity/Oxygen_SOP/issues/212#issuecomment-1137067184_

[soerenthomsen]

This issue is just to keep track of the whole pdf creation, GitHub release, submission to OBPS process to help the other SOPs leads (i.e. @patricialg @tomhull @isgiddy, @gkrahmann, @AlicePietri, @AnthonyBosse) to be able do the same. Just tag you here so you can observe :)

[soerenthomsen]

Build jupyter book (html+pdf) locally

Step 1: Downloaded the whole Oxygen_SOP repo to my local machine

Step 2: Installed Jupyter book on my local machine conda install -c conda-forge jupyter-book https://jupyterbook.org/en/stable/start/overview.html?highlight=Install#install-jupyter-book

Step 3: Build book locally jupyter-book build Oxygen_SOP/ --builder pdfhtml

Error message

The problem seems to be related to sphinx / apa style. I might need to install some more packages?!

[soerenthomsen]

installed pip install pyppeteer and pip install pybtex-apa-style

As listen in the requirements.txt file

[soerenthomsen]

[soerenthomsen]

Something happened in the html folder and looks good, but the pdf folder is still empty...

[soerenthomsen]

We decided to build the pdf directly in the repo to avoid these problems. See GitHub Action here

This is already implemented as part of the CI: https://github.com/OceanGlidersCommunity/Oxygen_SOP/blob/f2875f30724ac5d2439dab34f4663185e90db3f1/.github/workflows/build_book.yml#L64-L71

[jbusecke]

Closing this as v1.0.0 has been released.

[soerenthomsen]

Sorry, I had to reopened this as I realised that the pdf has no page numbers :( Hope we can fix this quickly!

OceanGliders_Oxygen_SOP_v1.0.0.pdf

I planed to submit this to OBPS today but we need page numbers. If anyone finds a quick solution let me know @tomhull @jbusecke @isgiddy

Note the pdf build within this action and can be downloaded there.

[jbusecke]

Trying some things in #224

[soerenthomsen]

Thanks a lot. Let me know if I can do anything. I could not find anything in the Jupyter Book documentation.

[jbusecke]

It seems to be under active discussion: https://github.com/executablebooks/jupyter-book/issues/546

But I am not sure that will help us here. I see two options:

• Use latex to generate the pdf and hope that has page numbers (trying that right now)
• Add some custom html to show page numbers (maybe this could help). Seems super janky though..
• Screw it and just try to add them manually in acrobat? Not sure that works, ....

[jbusecke]

YISSSS, the latex worked. I actually think it looks a bit cleaner than the html version too.

Can you check if this works?