Run update_docs when running the dev-suite

[badpandabear]

I added a "docs" test type to the pypeit_test script that runs the update_docs script and checks its output for errors. It also checks to see if PypeIt is being run from git and will skip the test if it is not.

Full success output:

Test Summary
--------------------------------------------------------
--- PYPEIT UNIT TESTS PASSED  247 passed, 58 warnings in 248.39s (0:04:08) ---
--- PYPEIT DEVELOPMENT SUITE UNIT TESTS PASSED  133 passed, 170 warnings in 645.86s (0:10:45) ---
--- PYPEIT UPDATE DOCS PASSED Sphinx build successful.---
--- PYPEIT DEVELOPMENT SUITE PASSED 0/0 TESTS  ---
Testing Started at 2024-02-06T14:27:22.930569
Testing Completed at 2024-02-06T14:43:59.681371
Total Time: 0:16:36.750802

Failure output:

Test Summary
--------------------------------------------------------
--- PYPEIT UPDATE DOCS FAILED Sphinx build FAILED: 7 warnings found.---
--- PYPEIT DEVELOPMENT SUITE PASSED 0/0 TESTS  ---
Testing Started at 2024-02-12T13:44:38.454089
Testing Completed at 2024-02-12T13:46:27.228778
Total Time: 0:01:48.774689

Skipped output:

Test Summary
--------------------------------------------------------
--- PYPEIT UPDATE DOCS PASSED SKIPPED: PypeIt not in git---
--- PYPEIT DEVELOPMENT SUITE PASSED 0/0 TESTS  ---
Testing Started at 2024-02-12T13:48:11.964524
Testing Completed at 2024-02-12T13:48:11.970962
Total Time: 0:00:00.006438

[badpandabear]

@kbwestfall For your first point, I may be missing something. From what I can, when I run pip install pypeit[docs] or even pip install pypeit [dev,test,docs] in a new virtual environment, nothing under PypeIt/docs is installed anywhere in the virtual environment directory. That's why I added the code to make sure pypeit is being run from git. Am I missing an argument to pip? Or are they not being installed when they should be? I'll have to think more about your last point and how to tell if the updates have been committed on the branch.

[kbwestfall]

Closing until we can think through the best solution.