2021 position of apptainersingularity pages in tocs is unexpected

[Carldkennedy]

Renamed singularity.rst to apptainer.rst
Added stub for singularity

[Carldkennedy]

However, Singularity/Apptainer still shows along with Apptainer/Singularity in TOC even though added :hidden: yes to stub
Should we keep this double entry?

[willfurnass]

I don't think we need 'Singularity' entries in TOCs provided that people can still find mention of Singularity on Apptainer pages via the site's search functionality.

[willfurnass]

I don't think we need 'Singularity' entries in TOCs provided that people can still find mention of Singularity on Apptainer pages via the site's search functionality.

[willfurnass]

I don't think we need 'Singularity' entries in TOCs provided that people can still find mention of Singularity on Apptainer pages via the site's search functionality.

[nikishe]

/home/runner/work/sheffield_hpc/sheffield_hpc/stanage/software/apps/index.rst:6:toctree contains reference to document 'stanage/software/apps/singularity'

[Carldkennedy]

Singularity was still being picked up by toc even though orphan directive added to .rst

[jkwmoore]

I think manually specifying the sub pages like this is a bad idea even if it does resolve two entries for Apptainer.

[Carldkennedy]

Conflicting opinions here. Does anyone knows of a fix that would hide singularity from the toc (other than :orphan: directive)

[jkwmoore]

I have added a commit which should achieve what we want. Let me know what people think. If we are happy with this we should also add a small amount of info to the README.

Some additional context on why bodge (no better native methods that Sphinx support yet/still):

• exclusions from globbing sphinx-doc/sphinx#9969
• Allow regex in toctree directive. sphinx-doc/sphinx#6650

[Carldkennedy]

LGTM @jkwmoore, thank you!