Add action for setting up parameters docs

[hdoupe]

@MaxGhenis When you get a chance, can you post the commands needed to create the parameters docs? You're also welcome to add commits to this PR with the commands.

Once those are up, I'll try to deploy this on my fork and see if it works.

[MaxGhenis]

Sorry for the delay, it's just python docs/guide/make/make_uguide.py

[hdoupe]

@MattHJensen #2450 is ready. Hope it works! 🤞

[MattHJensen]

@hdoupe, would you mind restating what this new action is going to do, and when?

[hdoupe]

It updates the parameter docs after each release is published. This way the parameter docs are stable in between releases even if new parameters are added/removed on the master branch.

[hdoupe]

The chat logs for a little posterity:

[codecov]

Codecov Report

Merging #2450 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2450   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          13       13           
  Lines        2582     2582           
=======================================
  Hits         2580     2580           
  Misses          2        2           

Impacted Files	Coverage Δ
taxcalc/policy.py	100.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8e86cbc...61248df. Read the comment docs.

[MattHJensen]

I'm not sure that I have a problem with this -- still need to think about it -- but I want to clarify: the downside of this approach is that broken docs won't be caught until after the release. At that point, the build will fail and we'll have to scramble to issue a new bugfix release. Is that right?

[MaxGhenis]

How about adding it to https://github.com/PSLmodels/Tax-Calculator/blob/master/.github/workflows/check_jupyterbook.yml to avoid Matt's concern?

[MattHJensen]

How about adding it to https://github.com/PSLmodels/Tax-Calculator/blob/master/.github/workflows/check_jupyterbook.yml to avoid Matt's concern?

This makes sense to me.

[hdoupe]

@MaxGhenis and @MattHJensen I removed the parameters github action and moved the parameter docs deploy command to the regular jupyterbook deploy action.

[MattHJensen]

@hdoupe, I think @MaxGhenis's suggestion was to keep your new action to deploy on Releases but to test the deploy on PRs. I may have misunderstood though.

[MaxGhenis]

Need to run make_uguide.py first. These four lines could be consolidated to:

python docs/guide/make/make_uguide.py
jb build docs/.

Or could cd docs once at the beginning.

[MaxGhenis]

@hdoupe, I think @MaxGhenis's suggestion was to keep your new action to deploy on Releases but to test the deploy on PRs. I may have misunderstood though.

Yes, though consolidating deploy actions also makes sense.

[MattHJensen]

Yes, though consolidating deploy actions also makes sense.

Yea, I'm now ok with whatever is easiest here, even if it means these get deployed on every PR to master. I am planning to open an issue next week discussing how the project can work towards continuous deployment, which would resolve any concerns about docs and releases being out of sync.

[hdoupe]

@MaxGhenis can you give #2450 another look over when you get a chance? Sorry for misunderstanding your comment earlier. Now, things are set up so:

• On PR's, the make_uguide.py script is run along with the other Jupyter Book build commands.
• On release, the updated parameter docs are deployed.

Is this what you and @MattHJensen had in mind?

[MaxGhenis]

LGTM, thanks @hdoupe

[MattHJensen]

@hdoupe, thanks a lot for your work on this, and @MaxGhenis, thanks for the review and suggestions.

@hdoupe, drop the WIP tag when this is ready to go and I'll give it a last look and merge.

[hdoupe]

@MattHJensen sure thing! Sorry for the delay on getting the updates in. I just added @MaxGhenis's commit. Once the tests pass, this will be good to go.

[MattHJensen]

I'm not sure why the linux 3.8 build has been queued for hours. I'm going to restart the tests,

[MattHJensen]

Merging!