search

JuliaRheology / RHEOS.jl

RHEOS - Open Source Rheology data analysis software
MIT License
39 stars 9 forks source link

Documentation generation fails #160

Closed akabla closed 6 months ago

akabla commented 6 months ago

This is happening when we create the plots for the different models, so probably caused by PyPlot. The doc scripts run fine locally.

akabla commented 6 months ago

I simplified the plotting to bypass the python function. 33a2632168fec395450432a031e0658136dd0a06

Still same error.

akabla commented 6 months ago

The issue comes at the execution of the scripts to generate the figure, both for the notebooks and production of html from jl files. I turned off the execution of the notebook, which flagged a more friendly error message downstream. There is an odd keyword for the grid command (b=...) which isn't available on the doc. I removed it, and it seems to help a lot. 9a3f1a3422a37b8f2b12d078535f94824a1abf6f

I believe that the documentation is now generated properly, but can't be pushed back to the repository. There is another error:

Error: Git failed to fetch git@github.com:JuliaRheology/RHEOS.jl.git
│ This can be caused by a DOCUMENTER_KEY variable that is not correctly set up.
│ Make sure that the environment variable is properly set up as a Base64-encoded string
│ of the SSH private key. You may need to re-generate the keys with DocumenterTools.

So that's the next hurdle!

akabla commented 6 months ago

This page seems to describe the process: https://github.com/cscherrer/SossMLJ.jl/issues/18

  1. Use the DocumenterTools.genkeys() function (part of the DocumenterTools.jl package) to generate a public key and the corresponding Base64-encoded private key.
  2. Create a new GitHub Secret on this repository where the name is DOCUMENTER_KEY and the contents are the Base64-encoded private key.
  3. Add the public key as a deploy key on this repository. Make sure that the deploy key has write access.

There is a documenter_key present, but no public key.

akabla commented 6 months ago

Setting a new private and public key did the trick here. Instructions above worked perfectly.