search

MHKiT-Software / MHKiT

MHKiT Documentation
https://MHKiT-Software.github.io/MHKiT/
4 stars 13 forks source link

Documentation CI/Action #62

Open simmsa opened 1 month ago

simmsa commented 1 month ago

We need better tooling for recognizing and reporting documentation build warnings and errors. #61 details the current output during make html

At first glance https://github.com/marketplace/actions/sphinx-build may be a option.

akeeste commented 1 month ago

@simmsa I completely agree. I have several thoughts on broader efforts to improve the automation, CI and workflow of our docs:

  1. Clarify the automation process for users.
  2. Remove outdated CI build (.gitlab-ci.yml)
  3. Investigate deployment of incorrect docs? See note here: https://github.com/MHKiT-Software/MHKiT/pull/60#issuecomment-2113011710
  4. Create a CI action that runs on both PRs into MHKiT-Python and MHKiT-MATLAB to test the documentation build. This would help avoid a lot of minor formatting errors as we go, and ensure that updates are always incorporated into the documentation.