This repository has been archived by the owner on Sep 4, 2024. It is now read-only.
Consider switching sphinx build github action #49
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
package
An output package needs to be created
Milestone
Is your feature request related to a problem? Please describe.
The github action we are using for building sphinx docs does not have support for pre-build commands. We need to be sure to update the api docs before running the sphinx build so that the latest code documentation is included (important if we change functions / modules / etc, not so if we update code within existing). The following command does this:
I have also added this to the Makefile for
make html
calls.We are currently using the Sphinx-notes pages GitHub action and it does not support pre-build commands or using our
Makefile
.We have a couple of options that could do this though
The text was updated successfully, but these errors were encountered: