Build docs for 4.7.1

[thomashoneyman]

On a recent build of the docs directory — via the work.sh script — I noticed the build produces an update to the docs that include moving from Pact 4.7.0 to 4.7.1 and the addition of a disable runtime checking flag. Indeed, 4.7.1 is the latest release and the changelog specifies the addition of the new flag.

I also see that in the PR checklist there's a note that cabal run tests should update the docs, but doing so does not create any change in the docs, whereas running work.sh directly does. Is that out of date? Or is the docs update from work.sh unanticipated?

---

PR checklist:

• [ ] Test coverage for the proposed changes
• [ ] PR description contains example output from repl interaction or a snippet from unit test output
• [ ] Documentation has been updated if new natives or FV properties have been added. To generate new documentation, issue cabal run tests. If they pass locally, docs are generated.
• [ ] Any changes that could be relevant to users have been recorded in the changelog
• [ ] In case of changes to the Pact trace output (pact -t), make sure pact-lsp is in sync.

Additionally, please justify why you should or should not do the following:

• [ ] Confirm replay/back compat
• [ ] Benchmark regressions
• [ ] (For Kadena engineers) Run integration-tests against a Chainweb built with this version of Pact

[thomashoneyman]

Oops — this probably ought to be closed, since I see 4.8 was released yesterday and I hadn't updated my fork yet. Still, I'm surprised not to see these 4.7.1 changes in already, or the 4.8.0 changes, so I'm curious about the proper way to generate docs between executing work.sh or using cabal run tests — whichever it is, it seems like the docs are not staying up-to-date with the master branch.

[emilypi]

Superseded by https://github.com/kadena-io/pact/pull/1288

I'm curious about the proper way to generate docs between executing work.sh or using cabal run tests — whichever it is, it seems like the docs are not staying up-to-date with the master branch.

There's a discrepancy here between RTD and what's generated via the tests: tests run the cabal macros that update version info and make any updates needed to the .md's for the RTD, but the docs/build.sh script generates the RTD .rsts from the .md's. So, there's two steps to fully generate docs:

1. run cabal run hspec
2. build the RTD's

The workflow is very manual, and we're working on migrating to an automatic release process so these things don't get dropped in the future.