Coverage for fpdf2_textindex/__init__.py: 100.00%

1""" 

2.. include:: ../README.md 

3 :end-before: # fpdf2 Text Index 

4 

5--- 

6 

7.. include:: ../README.md 

8 :start-after: # fpdf2 Text Index 

9 

10--- 

11 

12The module gives direct access to some classes defined in submodules: 

13 

14* :py:class:`fpdf2_textindex.Alias` 

15* :py:class:`fpdf2_textindex.CrossReference` 

16* :py:class:`fpdf2_textindex.CrossReferenceType` 

17* :py:class:`fpdf2_textindex.FPDF` 

18* :py:class:`fpdf2_textindex.FPDF2TextindexError` 

19* :py:class:`fpdf2_textindex.LinkLocation` 

20* :py:class:`fpdf2_textindex.Reference` 

21* :py:class:`fpdf2_textindex.TextIndexEntry` 

22* :py:class:`fpdf2_textindex.TextIndexRenderer` 

23""" # noqa: D212, D415 

24 

25# Monkey-patch fpdf bugs first 

26import fpdf2_textindex._fpdf # noqa: F401 

27from fpdf2_textindex.errors import FPDF2TextindexError 

28from fpdf2_textindex.interface import Alias 

29from fpdf2_textindex.interface import CrossReference 

30from fpdf2_textindex.interface import CrossReferenceType 

31from fpdf2_textindex.interface import LinkLocation 

32from fpdf2_textindex.interface import Reference 

33from fpdf2_textindex.interface import TextIndexEntry 

34from fpdf2_textindex.pdf import FPDF 

35from fpdf2_textindex.renderer import TextIndexRenderer 

36from fpdf2_textindex.version import FPDF2_TEXTINDEX_VERSION 

37 

38__docformat__ = "google" 

39__license__ = "GPL 3.0" 

40__version__ = FPDF2_TEXTINDEX_VERSION 

41 

42__all__ = ( # noqa: RUF022 

43 "Alias", 

44 "CrossReference", 

45 "CrossReferenceType", 

46 "FPDF", 

47 "FPDF2TextindexError", 

48 "LinkLocation", 

49 "Reference", 

50 "TextIndexEntry", 

51 "TextIndexRenderer", 

52 "__license__", 

53 "__version__", 

54)