kalekundert / autoclasstoc

Sphinx plugin to make easier-to-navigate class documentation.
MIT License
18 stars 7 forks source link

Update autosummary cross-reference syntax #40

Closed kalekundert closed 3 weeks ago

kalekundert commented 3 weeks ago

This is meant to fix #39.

New versions of autosummary make it much more difficult to specify cross references. Before, it was always correct to use fully-qualified names. Now, if the autosummary directive is contained within a class, its cross references must not start with the name of the module that that class is defined in. In other words, the cross references must be relative, not absolute, in this case. If the autosummary directive is not contained within a class, then fully-qualified names are still required. This adds a bunch of annoying complexity to the code.

codecov-commenter commented 3 weeks ago

:warning: Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 98.67%. Comparing base (881da02) to head (654b1e4). Report is 1 commits behind head on master.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #40 +/- ## ========================================== + Coverage 98.51% 98.67% +0.16% ========================================== Files 6 6 Lines 270 303 +33 Branches 37 28 -9 ========================================== + Hits 266 299 +33 Misses 1 1 Partials 3 3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.