Address JOSS review comments

[Yurlungur]

PR Summary

In the the JOSS review #391 @parikshitbajpai points out two issues. The first is that the examples directory is not documented. The second is that the paper seems to blend the statement of need and state of the field sections. I address both comments here:

For openjournals/joss-reviews#6805

• For the exampled directory, I add a page to the documentation explaining how to build and run the examples, as well as what they do. I also noticed a few problems, which I resolve:
  • The customizing page of the docs was not properly indexed and was not showing up in HTML builds.
  • The CMake for the examples folder was actually commented out in the build system. This must have been an intermediate debugging change that somehow made it into main.
  • The example that gets sound speed and pressure must not have been built in a while because it showed usage of the deprecated EOSBuilder machinery, which no longer exists.
• For the paper, I merge the two sections and simply call the joint section statement of need and state of the field.

PR Checklist

• Adds a test for any bugs fixed. Adds tests for new features.
• Format your changes by using the make format command after configuring with cmake.
• Document any new features, update documentation for changes made.
• Make sure the copyright notice on any files you modified is up to date.
• After creating a pull request, note it in the CHANGELOG.md file.
• LANL employees: make sure tests pass both on the github CI and on the Darwin CI

If preparing for a new release, in addition please check the following:

• Update the version in cmake.
• Move the changes in the CHANGELOG.md file under a new header for the new release, and reset the categories.

[jhp-lanl]

Minor typos.

I skimmed the actual HTML documentation build and it looks good, but please give it a check of your own to ensure it looks as you intend it to look
https://lanl.github.io/singularity-eos/jmm/document-examples/src/examples.html#examples

[parikshitbajpai]

This looks great to me and addresses both my comments in #391. A very minor suggestion to fix the directory name but otherwise it looks great.

[Yurlungur]

Minor typos.

I skimmed the actual HTML documentation build and it looks good, but please give it a check of your own to ensure it looks as you intend it to look https://lanl.github.io/singularity-eos/jmm/document-examples/src/examples.html#examples

Yep. I actually renewed my practice of building the html locally. This helped me find a bunch of problems I fixed here. :)

[junghans]

That looked good to me as well.