Fix doc pipeline & add documentation on running HLT1 and HLT2 over simulation
This MR adds a new page to the documentation to show (and explain) how to run HLT1 and HLT2 over MC. It uses literal-include
to grab code for examples that are tested in the nightlies, so the code examples will not become outdated unless they stop being tested.
There's pressure from OPG to get these instructions out, so I intend to just add the page, advertise it, and fix the doc build for now. Over the next few weeks, the Moore documentation needs a bit of a top-level reorganisation, which I'll do as a follow-up.
The new web page can be found at https://rjhunter.web.cern.ch/tutorials/running_over_mc.html
I also made a few hacks to get the docs to build.
TODO:
-
Improve on hacks -
Put the pages on a web space so people can see them -
Use call_allen_decision_logger()
for more helpful HLT1 example -
Add a bit about what conditions_version
means
Merge request reports
Activity
added Documentation label
assigned to @rjhunter
added RTA label
- Resolved by Ross John Hunter
added 22 commits
-
1fad4b02...85c1a17b - 16 commits from branch
master
- cb0a2900 - Hack around recent error to get docs to build
- 20adc4a3 - use correct title types in hlt1 to hlt2 tutorial so it appears as only 1 page...
- 87bdd325 - Upgrade to Sphinx5.0 to get docs to build
- a5ba29c6 - First punt at a running HLT2 over simulation page
- 91253923 - Register new page in the index
- dd2225e0 - Rearrange a bit and hopefully fix linkcheck
Toggle commit list-
1fad4b02...85c1a17b - 16 commits from branch
added 19 commits
-
dd2225e0...e934ef19 - 12 commits from branch
master
- 8578f934 - Hack around recent error to get docs to build
- b6396781 - use correct title types in hlt1 to hlt2 tutorial so it appears as only 1 page...
- 4225bff2 - Upgrade to Sphinx5.0 to get docs to build
- 2bdb0b82 - First punt at a running HLT2 over simulation page
- 5d91e744 - Register new page in the index
- fbe0cf89 - Rearrange a bit and hopefully fix linkcheck
- 906f67f6 - Add a little about what options.geometry_version means
Toggle commit list-
dd2225e0...e934ef19 - 12 commits from branch
added 2 commits
added 47 commits
-
a8e89ffa...805a1022 - 24 commits from branch
master
- 805a1022...6328d308 - 13 earlier commits
- 5ea7d39d - Simplify example - couldnt get the logger to work yet
- fdab1bfa - Simplify description accordingly in docs
- 6c8e852a - Please doc build
- 77673a65 - Please the liner
- 6c8cb429 - A few aesthetic fixes
- 00001eab - Add a few catches for different configuration parameters you may need to give
- 0d6ae01a - Correct bit on reco from file =True by default
- 3aaf732c - Fix a link
- 05684914 - Fix a few linting errors and add some temp debugging statements to isolate the doc failure
- 6e64ae74 - Improve on hacks in fixing documentation, and fix some linter errors, wrong...
Toggle commit list-
a8e89ffa...805a1022 - 24 commits from branch