Discussing files and examples numbering
Currently the files and examples used throughout Assignments are labeled with an hard-coded number.
This number does not make much sense for several reasons:
Such files and examples are only showed in Compiler Stages and thus are of the formActually such files and examples are showed in Compiler Stages AND Tools but the point remains
- The tens digit of the
npart is supposed to refer to a distinct stage of TC
- This limits the number of named samples for a given stage to 10 files
- However this limit is sometimes exceeded and two stages are split on the same tens digit
- Mainly this makes an addition of a new sample an excruciating task.
Unfortunately, Sphinx does not offer a direct alternative for an automated indexing of included files and samples (or I have missed it).
We could get rid of these numbers which do not mean much to us.
Sphinx provides for
literalinclude code blocks an attribute,
caption, that displays the given caption or the file name by default. The following image showcases the
caption attribute alongside the current label.
However this time it is
sphinxcontrib-programoutput that is troublesome as it does not offer this label for the output of a command.
What should be the way to go ?