InsightSoftwareConsortium / itk-dreg

A framework for distributed large-scale image registration
http://itk-dreg.readthedocs.io/
Apache License 2.0
5 stars 2 forks source link

ENH: Add workflow to deliver API documentation with Sphinx #12

Closed tbirdso closed 9 months ago

tbirdso commented 9 months ago

Adds GitHub Actions workflow to build API documentation with sphinx-apidoc and sphinx-build and make available as a GitHub artifact for download. HTML documentation is generated solely from Python docstrings for now, but could be expanded with a README and more descriptive content in the future.

Partially addresses https://github.com/InsightSoftwareConsortium/itk-dreg/issues/10.

See HTML artifact: https://github.com/tbirdso/itk-dreg/actions/runs/6868689278

We can follow up this PR with automated docs deployment to github.io.