Automatically generated hlt2 line reference documentation pages
Only displays a skeleton of the line configuration.
wishlist:
- expanded combiner details (cuts) and stats (rates, timings, and such)
- fix module docstrings to be Sphinx-friendly
- less ugly formatting
Edited by Ryunosuke O'Neil
Merge request reports
Activity
added Documentation hlt2 selection labels
added RTA label
added 1 commit
- ac3d9989 - updated makefile with hlt2lineref_docs target
Resolved by Eduardo Rodrigues- Last reply by Eduardo Rodrigues
added 1 commit
- 0cdcc332 - use -n flag to not run any events during line dump
Resolved by Ryunosuke O'Neil- Last reply by Ryunosuke O'Neil
added 1 commit
- e7f7bbe1 - refactor into functions and generate one file per line
added 1 commit
- 179fa12a - make hlt2_lines directory if it doesn't already exist
added 54 commits
-
0be2f601...b1f79fab - 46 commits from branch
master - 8ef98901 - hlt2 line docs
- 04b61bbc - updated makefile with hlt2lineref_docs target
- cca9fc0e - fixes
- 61f40ce4 - working makefile
- f3a0cd31 - use -n flag to not run any events during line dump
- 256ac46a - Cleaning dump_line_data.py
- 574d746f - refactor into functions and generate one file per line
- 53915b40 - make hlt2_lines directory if it doesn't already exist
Toggle commit list-
0be2f601...b1f79fab - 46 commits from branch
added 13 commits
- ae1cc86e - hlt2 line docs
- ac3d9989 - updated makefile with hlt2lineref_docs target
- b79a11e1 - fixes
- a28469ba - Fixed formatting
- cb717d87 - working makefile
- 0cdcc332 - use -n flag to not run any events during line dump
- 27e37404 - Cleaning dump_line_data.py
- 2d664dc2 - Added missing import.
- e7f7bbe1 - refactor into functions and generate one file per line
- 6a865e58 - Fixed formatting
- 179fa12a - make hlt2_lines directory if it doesn't already exist
- 0be2f601 - Fixed formatting
- ef8be18a - write-->read mode
Toggle commit listadded 2 commits
added 2 commits
- Resolved by Ryunosuke O'Neil
I made some progress yesterday with combiner documentation:
Need to come up with a good way to format and display the cuts.
Additionally,
- one page is generated per line
-
autofunctionis used where possible to provide links to builder source code. This doesn't always work for nested/inline builders that cannot be imported.
Welcome any suggestions for useful or missing information that could be added. Now that we have one page generated per line, we can be as verbose as we like.
Edited by Ryunosuke O'Neil - Last reply by Ryunosuke O'Neil
added 91 commits
-
6e7ccc29...f8597577 - 58 commits from branch
master - 236a483d - hlt2 line docs
- 6d3e4081 - updated makefile with hlt2lineref_docs target
- f84a9c86 - fixes
- ca7ebf01 - Fixed formatting
- 61e22234 - working makefile
- e59bc919 - use -n flag to not run any events during line dump
- 6e7cf8f8 - Cleaning dump_line_data.py
- be7920fd - Added missing import.
- 3a033bf8 - refactor into functions and generate one file per line
- 3f332579 - Fixed formatting
- ca58ccdc - make hlt2_lines directory if it doesn't already exist
- ea7f624b - Fixed formatting
- 50139581 - write-->read mode
- 8ac28bc9 - added missing f""
- 51c45e9f - Add titles to each line doc
- 13cdf225 - add toggle for heading
- 9f18d308 - Fix indentation
- 8f57af52 - add heading to working group index
- 5db4f5ec - fix incorrect filenames in toctree
- 2eb2cd6e - add missing builder function name
- b1e37bb6 - Try autofunction
- 059e3e2c - deal with nested builders
- a4f148f9 - use ModuleNotFoundError
- 99f10493 - remove stray colon
- 5aa8ebee - use the relative path
- 6f0d22a5 - Use __qualname__.
- e54cc0c2 - add missing prepended module
- c4fdc0c1 - check importable by importing directly
- ff5b97d7 - combiner doc
- 35595e8c - combiner doc
- 093aeca2 - Fixed formatting
- 2cd6c1c7 - tweaked formatting
- 74317fea - discard crude formatter
Toggle commit list-
6e7ccc29...f8597577 - 58 commits from branch
added 29 commits
-
964f677d...6892cadb - 6 commits from branch
master - c4d144b6 - hlt2 line docs
- 6d446827 - updated makefile with hlt2lineref_docs target
- 74a001a2 - working makefile
- a4e7e1f0 - use -n flag to not run any events during line dump
- 99b98aa8 - Cleaning dump_line_data.py
- 3bdf2382 - refactor into functions and generate one file per line
- 5dee32fb - make hlt2_lines directory if it doesn't already exist
- d2e15a84 - Add titles to each line doc
- 383d4a77 - add toggle for heading
- 896ab832 - add heading to working group index
- 03e148d2 - fix incorrect filenames in toctree
- 8905ce42 - add missing builder function name
- 142809be - Try autofunction
- 3a4e2e30 - deal with nested builders
- fd0e06ea - use ModuleNotFoundError
- bfea2c6d - remove stray colon
- 9e8a3daa - use the relative path
- dcaea900 - Use __qualname__.
- ce9fd884 - add missing prepended module
- 0910deee - check importable by importing directly
- 42e0d561 - combiner doc
- 33e06b89 - discard crude formatter
- edead4cf - Ignore gitlab line anchors
Toggle commit list-
964f677d...6892cadb - 6 commits from branch
Please register or sign in to reply