Deconstrained
commented
1 year ago Follow-up: I just had the the realization that not doing this is the best way to go. The reason for it is that building and committing the HTML docs at a given version provides a snapshot of the docs for those cases where someone has to use an older version (i.e. a system still stuck on Python 2.7 or 3.5).
In such a case, it won't matter if the docstrings and Sphinx config has some incompatibility with Sphinx at that version (I ran a very similar issue frequently before Hashicorp's knowledge base started featuring versioned documentation) because the portable self-contained HTML docs are already there and there is no need to run any commands to generate it.
Committing doc rebuilds manually is getting really old. It's also contributing to bloat of the repo.
Acceptance criteria: there is an automated build and publish of docs (i.e. with CircleCI or GitHub Actions) so that changes to the restructured text / docstrings don't need doc rebuild commits and we can remove/git-ignore the built docs.