Documentation comments from Lynn

[greenc-FNAL]

Comments from @lgarren conversation regarding documentation as at 2023-10-10:

• Need a landing page at https://fnalssi.github.io or a redirect to https://fnalssi.github.io/cetmodules.
• Need a manual ToC entry in published reference back to landing page.
• On modules pages, need ToC entries for functions.

[greenc-FNAL]

@lgarren It looks like adding ToC entries for functions is not possible. It is possible to add sidebar sections, but autogenerating the correct links for each module page looks like a major rabbit hole that may only have a Vorpal Bunny waiting at the end.

[greenc-FNAL]

@lgarren Very basic landing page now up at https://fnalssi.github.io/

[lgarren]

@lgarren It looks like adding ToC entries for functions is not possible. It is possible to add sidebar sections, but autogenerating the correct links for each module page looks like a major rabbit hole that may only have a Vorpal Bunny waiting at the end.

Oh well

[greenc-FNAL]

Oh well

For this kind of thing I'm reliant on what the CMake people have decided works for them via https://pypi.org/project/sphinxcontrib-moderncmakedomain/. Based on what CMake's documentation looks like, I think I need to introduce and explain the commands explicitly in the top section of the module documentation. It won't be in the sidebar, but it there will be an annotated list near the top of the page with links to each function defined below.

Does that seem reasonable?

[greenc-FNAL]

@lgarren

[lgarren]

Whatever works? It sounds like a reasonable plan.