Documentation of reconstruction config

More sphinx documentation for the reconstruction config. See https://www.physi.uni-heidelberg.de/~mstahl/moore/

• spotted inconsistency between original make_pvs function and similar ones during writing docstrings. Now velo tracks have to be passed
• don't use makers to pass VP clusters to HitsLocation in both VP tracking algorithms

added 1 commit

• 2369b0b0 - the usual formatting commit

Compare with previous version

marked as a Work In Progress

changed the description

Currently 2 tests fail locally (didn't see it in the nightlies)

• test_hlt1_example with

PrFilter__PrFittedForwardTracksW...   FATAL  Standard std::exception is caught
PrFilter__PrFittedForwardTracksW...   ERROR Empty Functor<Out(In...)> called
HLTControlFlowMgr                     FATAL Event failed in Node CombineTracks__2Body__PrFittedForwardTracksWithPVs/CombineTracks__2Body__PrFittedForwardTracksWithPVs#1

• test_hlt2_all_lines with

File "/afs/cern.ch/work/m/mstahl/LHCbstack/Moore/Hlt/Hlt2Conf/options/hlt2_all_lines.py", line 22, in <module>
    options.set_conds_from_testfiledb('Upgrade_MinBias_LDST')
  File "/afs/cern.ch/work/m/mstahl/LHCbstack/Moore/PyConf/python/PyConf/application.py", line 215, in set_conds_from_testfiledb
    qualifiers = test_file_db[key].qualifiers
KeyError: 'Upgrade_MinBias_LDST'

added 1 commit

• c72e6288 - this has not been picked up...

Compare with previous version

Superb to see this @mstahl

Thanks very much for the docs!

Sphinx supports parsing Google and NumPy docstrings (see https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html), which are quite a bit more readable in the source, while the rendered documentation doesn't lose anything. We've chosen to follow the Google style (both have pros and cons).

Could you transform the new docstrings you added to follow that style? The sphinx docstring examples are super useful to get used to the style.

added 2 commits

• 93d07a6b - re-wrote documentation
• a96ae45a - small update after looking at the formated doc

Compare with previous version

resolved all threads

From my side this MR is ready. Let me know if there are further issues with it or if I can rebase and resolve the WIP status

Edit

• There are a couple of guessed argument- and return-types. It would be nice if somebody could check them.
• For later: How will other projects be cross-referenced? How would I reference to the doxygen documentation of PrForwardTracking for example?