[doc] Fixathon 2: documentation sprint by siliataider · Pull Request #22289 · root-project/root

siliataider · 2026-05-13T15:20:55Z

Cleanup, refactoring, cheat sheets, etc.

Changes summary

General

Remove source files from doxygen groups (\file xxx \ingroup yyy). These clutter the overview without adding useful documentation.
Remove/reorder groups that are used infrequently.
Enable inlining of inherited functions into the overview list. This significantly simplifies viewing/searching the available interface of a class.

Python Interface

Updated the dedicated Python Interface top-level section in the Doxygen navigation, with a landing page covering installation, quickstart and a quick overview
Added a new structured RDataLoader page walking users through data preparation, loader configuration, batch iteration etc.
Revamped the UHI page with an updated intro and a new Serialization section
Added two cheat sheets (RDataLoader and UHI) as a proof of concept (one-page PDF references downloadable and embedded directly in the docs too)
- TODO: update the UHi cheatsheet to make the plotting section more prominent
- TODO: once enough cheat sheets exist, refactor them into a dedicated Cheat Sheets index page

Search Engine

No changes for the moment

Preview

See a preview of the doxygen page here:
https://root.cern/doc/hackathon/index.html

Note: This webpage does not contain the full doyxgen run. Macros embedded in the source code are not being run.

ferdymercury

Thanks a lot for this endeavor!

Two remarks

QHP generation shouldn't be disabled for main Doxyfile since it's used to publish qch file which is fundamental for qtcreator IDE
it would be a lot cleaner if you used, as ALICE O2, this approach: #17426 rather than having two huge Doxyfiles almost impossible to review and annoying to maintain with warnings depending on version, etc

ferdymercury · 2026-05-14T11:21:43Z

 # This tag requires that the tag GENERATE_HTML is set to YES.

-GENERATE_QHP           = YES
+GENERATE_QHP           = NO


Suggested change

GENERATE_QHP = NO

GENERATE_QHP = YES

OK, we won't touch it. I thought nobody uses this. 😅

:) thanks
It's nice because it allows you press F1 in the IDE:
https://user-images.githubusercontent.com/10653970/154870916-28e4009d-eb70-46df-a52b-da81cfe3c97f.png
and that works also offline / no need to open web browser

vepadulano

Thank you for all of this work! I have reviewed the Python part of the PR, here are some comments from my side.

github-actions · 2026-05-15T14:52:34Z

Test Results

22 files 22 suites 3d 8h 41m 29s ⏱️
3 852 tests 3 852 ✅ 0 💤 0 ❌
76 090 runs 76 090 ✅ 0 💤 0 ❌

Results for commit fae36de.

♻️ This comment has been updated with latest results.

vepadulano · 2026-05-18T12:13:59Z

 *************************************************************************/

 /**
- * \defgroup treeplayer TTreePlayer


Why this change? TTreePlayer is the correct name of the class.

Quoting @hageboeck, either is fine, it's the Treeplayer library or the class TTreePlayer.

Indeed, but why this change was done I don't know. 🙂

I remember there was a discussion about the need to have the name of the doxygen group be the same name of the actual class so that it would show up properly on the left-bar. That discusion was in the context of the RDataLoader, so perhaps it doesn't apply here.

I just reverted the change

- Move the web widgets to the webdisplay group. - Move webdisplay to GUI group. - Put the parametric functions group under Math. - Regroup I/O doxygen groups. - Move doxygen GUI group to Graphics Co-authored-by: martinfoell <m.foell.1999@gmail.com>

- Remove internal and detail classes from RDF group. - Remove source files from RDF group. - Expand docs of RDataFrame overview page. - Structure documentation of RDataFrame API.

…xygen group. Listing files on the doxygen page doesn't have a lot of benefit. Instead, we will list the contained classes.

- Enable sorting of groups in the treeview - Enable right-hand side scrolling site overview - Add "make preview" for a fast preview mode without ROOT customisations, with MT processing, and without dot graphs - Enable inlining of inherited members into the overview of class functions

siliataider requested review from bellenot, couet, dpiparo, guitargeek, hageboeck, jblomer, linev, martamaja10, pcanal and vepadulano as code owners May 13, 2026 15:20

siliataider assigned siliataider and hageboeck May 13, 2026

siliataider marked this pull request as draft May 13, 2026 15:22

siliataider assigned silverweed and martinfoell May 13, 2026

siliataider added in:Documentation in:I/O in:Python Interface in:RDataFrame in:Hist in:ML Everything under ROOT/ML labels May 13, 2026

siliataider changed the title ~~Fixathon docs~~ [doc] Fixathon 2: documentation sprint May 13, 2026

siliataider force-pushed the fixathon_docs branch from 5db0a05 to c114459 Compare May 13, 2026 15:59

ferdymercury suggested changes May 14, 2026

View reviewed changes

siliataider force-pushed the fixathon_docs branch from c114459 to b397b7e Compare May 15, 2026 07:47

[doxygen-infra] Call the main page "main page" in the navigation tree.

dcf02fb

hageboeck force-pushed the fixathon_docs branch from b397b7e to f809570 Compare May 15, 2026 12:19

hageboeck added the clean build Ask CI to do non-incremental build on PR label May 15, 2026

[doxygen] Fix doxygen warnings.

1984c7f

hageboeck force-pushed the fixathon_docs branch from f809570 to cf59381 Compare May 15, 2026 12:39

siliataider marked this pull request as ready for review May 15, 2026 14:19

vepadulano requested changes May 15, 2026

View reviewed changes

siliataider requested a review from vepadulano May 18, 2026 10:04

hageboeck mentioned this pull request May 18, 2026

[RDF][Docs] Group the RInterface API in doxygen into Actions / Transformations / General #22320

Draft

vepadulano requested changes May 18, 2026

View reviewed changes

siliataider force-pushed the fixathon_docs branch from c4e18aa to fae36de Compare May 18, 2026 13:28

hageboeck and others added 13 commits May 19, 2026 14:14

[doc] Rename Core ROOT classes

a256f17

[doxygen-dataframe] Overhaul RDataFrame doxygen group

1f7884b

- Remove internal and detail classes from RDF group. - Remove source files from RDF group. - Expand docs of RDataFrame overview page. - Structure documentation of RDataFrame API.

[doxygen-files] Remove RNTuple source files from the corresponding do…

2012485

…xygen group. Listing files on the doxygen page doesn't have a lot of benefit. Instead, we will list the contained classes.

[doc][Python] Move the Python Interface section to top level

61bcd4d

[doc][Python] Add the Getting started page

acfdbf1

[doc][Python] Add ML cheat sheet and doc page

6ff4b92

[doc][Python] Update ML section

3886479

[doc][Python] Update getting started section

937f92b

[doxygen-groups] Extend the description of the RVec group.

b704d98

[doxygen] Remove file documentation pages from doxygen groups.

a76151b

[doc][Python] Add UHI cheatsheet and update section

6982863

siliataider force-pushed the fixathon_docs branch from fae36de to 9e3e5cf Compare May 19, 2026 12:15

siliataider added 2 commits May 19, 2026 14:45

[doc][Python] Add doxygen docstrings to the ML section + refactoring

e608034

[doc][Python] add _pythonization directory to Doxygen INPUT

9b486d3

siliataider force-pushed the fixathon_docs branch from 9e3e5cf to 9b486d3 Compare May 19, 2026 12:46

Conversation

siliataider commented May 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes summary

General

Python Interface

Search Engine

Preview

Uh oh!

ferdymercury left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vepadulano left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

siliataider commented May 13, 2026 •

edited

Loading

github-actions Bot commented May 15, 2026 •

edited

Loading