Build GitHub pages with write permissions - deploy via worfklow dispatch and on publish

[bobleesj]

We want to build docs when published (GitHub release) or by workflow dispatch.

[github-actions]

Warning! No news item is found for this PR. If this is a user-facing change/feature/fix,
please add a news item by copying the format from news/TEMPLATE.rst.

[bobleesj]

Without this write-permission, I previously had

   15 files changed, 78 insertions(+), 107 deletions(-)
Push the commit or tag
  /usr/bin/git push origin gh-pages
  remote: Permission to bobleesj-test-org/bobleesj.release.git denied to github-actions[bot].

[bobleesj]

The correct syntax

Ref: https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#release

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.78%. Comparing base (402e7d5) to head (b65ad58).
Report is 3 commits behind head on main.

Additional details and impacted files

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

[bobleesj]

Ready for review @sbillinge. This will fix the current issue of not displaying the latest changelog. Ref scikit-package/release-scripts#94

Once you've merged this, could you please run this Deploy Documentation on Release workflow via dispatch? We should then see the latest v0.2.0 news under here https://www.diffpy.org/diffpy.fourigui/release.html

[bobleesj]

@cadenmyers13 cc'ing Caden here. Since Andrew's PR has been merged #67, let's also check whether the API section builds.

[sbillinge]

Deploy docs workflow ran successfully on dispatch

[sbillinge]

Changeling appears in the docs now but still no API documentation building?

[bobleesj]

Deploy docs workflow ran successfully on dispatch
awesome!

@cadenmyers13 could you please check with Andrew why Api doc isn't rendering ?

https://github.com/Billingegroup/release-scripts/blob/v0/.github/workflows/_publish-docs-on-release.yml

This is the script that @sbillinge used to re-render the doc - displaying the latest changelog 0.2.0 now.