Add headless to true to doc GitHub build workflow to sudo apt-get install -y xvfb

[bobleesj]

The goal of this PR is to ensure we can render API doc strings with our linux CI.

Closes #70 - fixing API docstrings
Closes #18 - build API doc
Closes #33 - fixing doc link

[bobleesj]

@sbillinge ready for review

@cadenmyers13 once this is merged, let's try to deploy the doc from your forked repo and let's see if this works!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.78%. Comparing base (5a437f2) to head (26be37f).
Report is 3 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #71   +/-   ##
=======================================
  Coverage   93.78%   93.78%           
=======================================
  Files           4        4           
  Lines         177      177           
=======================================
  Hits          166      166           
  Misses         11       11           

[cadenmyers13]

@bobleesj I made the edits and the API rendered properly 👍 Just add a news item and this should be good to go once reviewed

[bobleesj]

@bobleesj I made the edits and the API rendered properly 👍 Just add a news item and this should be good to go once reviewed

Beautiful!!! Time to finally wrap our release up.

[bobleesj]

news added thanks @cadenmyers13

[sbillinge]

Thanks @bobleesj !

[bobleesj]

@cadenmyers13

@sbillinge deployed the docs by dispatch from main but it appears the API docs are not being rendered.

The screenshot above indeed indicate that you were able to render the API docstrings using this workflow. Could you check if there any difference between your forked fourigui and main?

https://github.com/diffpy/diffpy.fourigui/actions/runs/12209252446

[cadenmyers13]

@bobleesj There's no difference in code between my fork and upstream. I sync'd my fork with upstream and that rendered too. Not sure what the issue could be here. Do we need to trigger the build?

[sbillinge]

Could this be the problem maybe?:

WARNING: autodoc: failed to import module 'fourigui' from module 'diffpy.fourigui'; the following exception was raised:
Cannot load backend 'tkagg' which requires the 'tk' interactive framework, as 'headless' is currently running [autodoc.import_object]

[sbillinge]

Maybe we can't build the documentation headless, or we need another workaround? Pls could you look into it?

[cadenmyers13]

@sbillinge Where does this warning come from? Im not getting this warning when i build on my end. I'd like to reproduce locally.

[sbillinge]

That was in the log in the action called docs and then under build documentation. I am not sure what the problem is (and it could be happening at the deploy stage) but I just noticed that error. I don't know if it is the problem. Look here:
https://github.com/diffpy/diffpy.fourigui/actions/runs/12209241804/job/34063721050

[bobleesj]

#73

Please see this new PR, fixing this problem.