Skip to content

Autogenerate ThOr functor docs; Reorganise TOC structure

Ryunosuke O'Neil requested to merge roneil/autogen-thor-functor-docs into master

See here https://roneil.web.cern.ch/roneil/ThOrDocs/html/MooreThOrFunctors-nightly.html for an example

See the latest build-docs CI artifact for an example (navigate to ThOr functors: API Reference) There is a mirror here, as well: https://roneil.web.cern.ch/mooredoc/_build/html/selection/thor_functors_reference.html

Some things that are not crucial, but would be good to address sometime in the future:

  • at generation time, it would be nice to be able to extract the git tag / commit of the lhcb/Rec package that is used in the Moore build, to make sure that people reading Moore doc versions at earlier versions < current HEAD/master are able to get the links to the right versions of the ThOr C++ header source files, rather than always the latest versions.

  • Group functors together under general headings to aid user navigation. e.g. headings for "Track" variables, "Particle ID", etc.

  • Would be nice if the C++ header links take the user directly to the correct line of the file, where the functor definition begins.

    • a simple GET to the source file on GitLab, splitting the line, identifying the first line of the C++ functor definition, then finding the line number should do the job. Then #L<LINE NUMBER> can be appended to the link.
Edited by Ryunosuke O'Neil

Merge request reports