177 RST stubs for ReadTheDocs

[bbean23]

Purpose

Please briefly describe the purpose of this pull request. If this fixes a github issue please include e.g. fixes #22 so that the issue gets closed automatically when this is merged.

Summary of changes

• provided RST stubs for SpotAnalysis classes
• updated docstrings
• added classes to test_DocStringsExist.py

Implementation notes

Added AutoSummary to Sphinx for generating class name lists at the top of the documentation files.

Submission checklist

• Target branch is develop, not main
• Existing tests are updated or new tests were added
• opencsp/test/test_DocStringsExist.py are verified to include this change or have been updated accordingly
• .rst file(s) under doc/ are verified to include this change or have been updated accordingly

Additional information

none

[e10harvey]

Thank you for these changes @bbean23. I left some minor comments below. Please reorganize these rst files to match the directory structore of the code base, like this:
doc/source/library_reference/library/SpotAnalysis -> doc/source/library_reference/common/lib/cv/spot_analysis. I'd be happy to open a PR into your fork with these changes.

[bbean23]

I believe I've addressed all your comments. Please note that by "addressed" I sometimes mean "argued against", so please take a look at my comments to see if you agree or not.

[e10harvey]

Thank you @bbean23! I think this can be merged after the headings are made consistent with the rest of the library reference and "also maaaaaybe look at" is reworded to "also see".

[bbean23]

@e10harvey Please review again. I made some small changes in order to get the build to pass and documentation to render correctly:

• fixed docstrings in CacheableImage to be compatible with ReStructuredText
• changed "AbstractSpotAnalysisImagesProcessor" to "AbstractSpotAnalysisImageProcessor"