Improve pyreverse documentation

[Julfried]

Type of Changes

	Type
	🐛 Bug fix
	✨ New feature
	🔨 Refactoring
✓	📜 Docs

Description

Follow up to 10045

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.80%. Comparing base (ac2ae53) to head (9891da4).
Report is 8 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10063   +/-   ##
=======================================
  Coverage   95.79%   95.80%           
=======================================
  Files         174      174           
  Lines       18940    18962   +22     
=======================================
+ Hits        18144    18166   +22     
  Misses        796      796           

see 3 files with indirect coverage changes

[Pierre-Sassoulas]

I pushed the change I thought of (easier done than explained). Would you mind checking the result @DanielNoord ?

[DanielNoord]

I like it, but we need to tweak the toctree slightly:

When clicking on Filtering and Scope I remain on the Basic Usage location in the navigation. Can we fix that?

[Julfried]

I think this is intentional, because these sections are all on the same page. For me, if I click on Filtering and Scope, it just scrolls to the according section.

[DanielNoord]

Yes, but shouldn't it be another dropdown? They are on a different level than "Basic Usage" section wise, so it shouldn't be on the same level I think?

[Pierre-Sassoulas]

I don't know if we can do anything about it, isn't it a bug or feature from Sphinx auto generated toc ? (Moving them one level down, that we can do)

[DanielNoord]

Shouldn't we tweak this?

[Pierre-Sassoulas]

I'm trying to currently, we managed to do it for the dev guide so I should be able to.

[Pierre-Sassoulas]

This is surprisingly hard. Might have to change the headings underline again.

[Julfried]

I have a possible solution that fixes both the heading hierarchy and improves the documentation readability. Would you like me to create a commit with these changes?

[Pierre-Sassoulas]

Sure @Julfried, thank you for proposing (I tried to increase maxdepth without success)

[Julfried]

Here is my idea. One thing I noticed: this table of contents collapses when the window is narrow on smaller screens. Maybe this could be fixed in the theme settings. What do you think?

[Pierre-Sassoulas]

I think the current version is good enough ™️ (especially with the mini-toc created manually in Usage) Let me know what you think @DanielNoord :)

[DanielNoord]

Thanks!