@@ -505,23 +505,23 @@ def require_sphinx(version: tuple[int, int] | str) -> None:
505
505
# ---- Core events -------------------------------------------------------
506
506
507
507
@overload
508
- def connect ( # NoQA: E704
508
+ def connect (
509
509
self ,
510
510
event : Literal ['config-inited' ],
511
511
callback : Callable [[Sphinx , Config ], None ],
512
512
priority : int = 500 ,
513
513
) -> int : ...
514
514
515
515
@overload
516
- def connect ( # NoQA: E704
516
+ def connect (
517
517
self ,
518
518
event : Literal ['builder-inited' ],
519
519
callback : Callable [[Sphinx ], None ],
520
520
priority : int = 500 ,
521
521
) -> int : ...
522
522
523
523
@overload
524
- def connect ( # NoQA: E704
524
+ def connect (
525
525
self ,
526
526
event : Literal ['env-get-outdated' ],
527
527
callback : Callable [
@@ -531,47 +531,47 @@ def connect( # NoQA: E704
531
531
) -> int : ...
532
532
533
533
@overload
534
- def connect ( # NoQA: E704
534
+ def connect (
535
535
self ,
536
536
event : Literal ['env-before-read-docs' ],
537
537
callback : Callable [[Sphinx , BuildEnvironment , list [str ]], None ],
538
538
priority : int = 500 ,
539
539
) -> int : ...
540
540
541
541
@overload
542
- def connect ( # NoQA: E704
542
+ def connect (
543
543
self ,
544
544
event : Literal ['env-purge-doc' ],
545
545
callback : Callable [[Sphinx , BuildEnvironment , str ], None ],
546
546
priority : int = 500 ,
547
547
) -> int : ...
548
548
549
549
@overload
550
- def connect ( # NoQA: E704
550
+ def connect (
551
551
self ,
552
552
event : Literal ['source-read' ],
553
553
callback : Callable [[Sphinx , str , list [str ]], None ],
554
554
priority : int = 500 ,
555
555
) -> int : ...
556
556
557
557
@overload
558
- def connect ( # NoQA: E704
558
+ def connect (
559
559
self ,
560
560
event : Literal ['include-read' ],
561
561
callback : Callable [[Sphinx , Path , str , list [str ]], None ],
562
562
priority : int = 500 ,
563
563
) -> int : ...
564
564
565
565
@overload
566
- def connect ( # NoQA: E704
566
+ def connect (
567
567
self ,
568
568
event : Literal ['doctree-read' ],
569
569
callback : Callable [[Sphinx , nodes .document ], None ],
570
570
priority : int = 500 ,
571
571
) -> int : ...
572
572
573
573
@overload
574
- def connect ( # NoQA: E704
574
+ def connect (
575
575
self ,
576
576
event : Literal ['env-merge-info' ],
577
577
callback : Callable [
@@ -581,47 +581,47 @@ def connect( # NoQA: E704
581
581
) -> int : ...
582
582
583
583
@overload
584
- def connect ( # NoQA: E704
584
+ def connect (
585
585
self ,
586
586
event : Literal ['env-updated' ],
587
587
callback : Callable [[Sphinx , BuildEnvironment ], str ],
588
588
priority : int = 500 ,
589
589
) -> int : ...
590
590
591
591
@overload
592
- def connect ( # NoQA: E704
592
+ def connect (
593
593
self ,
594
594
event : Literal ['env-get-updated' ],
595
595
callback : Callable [[Sphinx , BuildEnvironment ], Iterable [str ]],
596
596
priority : int = 500 ,
597
597
) -> int : ...
598
598
599
599
@overload
600
- def connect ( # NoQA: E704
600
+ def connect (
601
601
self ,
602
602
event : Literal ['env-check-consistency' ],
603
603
callback : Callable [[Sphinx , BuildEnvironment ], None ],
604
604
priority : int = 500 ,
605
605
) -> int : ...
606
606
607
607
@overload
608
- def connect ( # NoQA: E704
608
+ def connect (
609
609
self ,
610
610
event : Literal ['write-started' ],
611
611
callback : Callable [[Sphinx , Builder ], None ],
612
612
priority : int = 500 ,
613
613
) -> int : ...
614
614
615
615
@overload
616
- def connect ( # NoQA: E704
616
+ def connect (
617
617
self ,
618
618
event : Literal ['doctree-resolved' ],
619
619
callback : Callable [[Sphinx , nodes .document , str ], None ],
620
620
priority : int = 500 ,
621
621
) -> int : ...
622
622
623
623
@overload
624
- def connect ( # NoQA: E704
624
+ def connect (
625
625
self ,
626
626
event : Literal ['missing-reference' ],
627
627
callback : Callable [
@@ -632,15 +632,15 @@ def connect( # NoQA: E704
632
632
) -> int : ...
633
633
634
634
@overload
635
- def connect ( # NoQA: E704
635
+ def connect (
636
636
self ,
637
637
event : Literal ['warn-missing-reference' ],
638
638
callback : Callable [[Sphinx , Domain , addnodes .pending_xref ], bool | None ],
639
639
priority : int = 500 ,
640
640
) -> int : ...
641
641
642
642
@overload
643
- def connect ( # NoQA: E704
643
+ def connect (
644
644
self ,
645
645
event : Literal ['build-finished' ],
646
646
callback : Callable [[Sphinx , Exception | None ], None ],
@@ -650,15 +650,15 @@ def connect( # NoQA: E704
650
650
# ---- Events from builtin builders --------------------------------------
651
651
652
652
@overload
653
- def connect ( # NoQA: E704
653
+ def connect (
654
654
self ,
655
655
event : Literal ['html-collect-pages' ],
656
656
callback : Callable [[Sphinx ], Iterable [tuple [str , dict [str , Any ], str ]]],
657
657
priority : int = 500 ,
658
658
) -> int : ...
659
659
660
660
@overload
661
- def connect ( # NoQA: E704
661
+ def connect (
662
662
self ,
663
663
event : Literal ['html-page-context' ],
664
664
callback : Callable [
@@ -668,7 +668,7 @@ def connect( # NoQA: E704
668
668
) -> int : ...
669
669
670
670
@overload
671
- def connect ( # NoQA: E704
671
+ def connect (
672
672
self ,
673
673
event : Literal ['linkcheck-process-uri' ],
674
674
callback : Callable [[Sphinx , str ], str | None ],
@@ -678,7 +678,7 @@ def connect( # NoQA: E704
678
678
# ---- Events from builtin extensions-- ----------------------------------
679
679
680
680
@overload
681
- def connect ( # NoQA: E704
681
+ def connect (
682
682
self ,
683
683
event : Literal ['object-description-transform' ],
684
684
callback : Callable [[Sphinx , str , str , addnodes .desc_content ], None ],
@@ -688,23 +688,23 @@ def connect( # NoQA: E704
688
688
# ---- Events from first-party extensions --------------------------------
689
689
690
690
@overload
691
- def connect ( # NoQA: E704
691
+ def connect (
692
692
self ,
693
693
event : Literal ['autodoc-process-docstring' ],
694
694
callback : _AutodocProcessDocstringListener ,
695
695
priority : int = 500 ,
696
696
) -> int : ...
697
697
698
698
@overload
699
- def connect ( # NoQA: E704
699
+ def connect (
700
700
self ,
701
701
event : Literal ['autodoc-before-process-signature' ],
702
702
callback : Callable [[Sphinx , Any , bool ], None ],
703
703
priority : int = 500 ,
704
704
) -> int : ...
705
705
706
706
@overload
707
- def connect ( # NoQA: E704
707
+ def connect (
708
708
self ,
709
709
event : Literal ['autodoc-process-signature' ],
710
710
callback : Callable [
@@ -725,15 +725,15 @@ def connect( # NoQA: E704
725
725
) -> int : ...
726
726
727
727
@overload
728
- def connect ( # NoQA: E704
728
+ def connect (
729
729
self ,
730
730
event : Literal ['autodoc-process-bases' ],
731
731
callback : Callable [[Sphinx , str , Any , dict [str , bool ], list [str ]], None ],
732
732
priority : int = 500 ,
733
733
) -> int : ...
734
734
735
735
@overload
736
- def connect ( # NoQA: E704
736
+ def connect (
737
737
self ,
738
738
event : Literal ['autodoc-skip-member' ],
739
739
callback : Callable [
@@ -753,15 +753,15 @@ def connect( # NoQA: E704
753
753
) -> int : ...
754
754
755
755
@overload
756
- def connect ( # NoQA: E704
756
+ def connect (
757
757
self ,
758
758
event : Literal ['todo-defined' ],
759
759
callback : Callable [[Sphinx , todo_node ], None ],
760
760
priority : int = 500 ,
761
761
) -> int : ...
762
762
763
763
@overload
764
- def connect ( # NoQA: E704
764
+ def connect (
765
765
self ,
766
766
event : Literal ['viewcode-find-source' ],
767
767
callback : Callable [
@@ -772,7 +772,7 @@ def connect( # NoQA: E704
772
772
) -> int : ...
773
773
774
774
@overload
775
- def connect ( # NoQA: E704
775
+ def connect (
776
776
self ,
777
777
event : Literal ['viewcode-follow-imported' ],
778
778
callback : Callable [[Sphinx , str , str ], str | None ],
@@ -782,7 +782,7 @@ def connect( # NoQA: E704
782
782
# ---- Catch-all ---------------------------------------------------------
783
783
784
784
@overload
785
- def connect ( # NoQA: E704
785
+ def connect (
786
786
self ,
787
787
event : str ,
788
788
callback : Callable [..., Any ],
@@ -1405,7 +1405,7 @@ def add_transform(self, transform: type[Transform]) -> None:
1405
1405
refs: `Transform Priority Range Categories`__
1406
1406
1407
1407
__ https://docutils.sourceforge.io/docs/ref/transforms.html#transform-priority-range-categories
1408
- """ # NoQA: E501,RUF100 # Flake8 thinks the URL is too long, Ruff special cases URLs.
1408
+ """
1409
1409
self .registry .add_transform (transform )
1410
1410
1411
1411
def add_post_transform (self , transform : type [Transform ]) -> None :
0 commit comments