Coverage for pyquickhelper/sphinxext/__init__.py: 100%

1""" 

2@file 

3@brief Subpart related to sphinx extensions 

4 

5.. todoext:: 

6 :title: add directive for a sortable table 

7 :tag: enhancement 

8 :issue: 27 

9 

10 Based on `slickgrid <https://github.com/mleibman/SlickGrid/tree/master/examples>`_. 

11""" 

12import warnings 

13from sphinx.ext.autodoc import setup as setup_autodoc 

14from sphinx.ext.imgmath import setup as setup_imgmath 

15from sphinx.ext.graphviz import setup as setup_graphviz 

16from sphinx.ext.todo import setup as setup_todo 

17 

18from .blog_post import BlogPost 

19from .blog_post_list import BlogPostList 

20from .sphinx_bigger_extension import bigger_node, bigger_role 

21from .sphinx_blocref_extension import BlocRef, BlocRefList 

22from .sphinx_blog_extension import BlogPostDirective, BlogPostDirectiveAgg 

23from .sphinx_cmdref_extension import CmdRef, CmdRefList 

24from .sphinx_epkg_extension import epkg_node 

25from .sphinx_exref_extension import ExRef, ExRefList 

26from .sphinx_faqref_extension import FaqRef, FaqRefList 

27from .sphinx_githublink_extension import githublink_node, githublink_role 

28from .sphinx_gitlog_extension import gitlog_node, gitlog_role 

29from .sphinx_mathdef_extension import MathDef, MathDefList 

30from .sphinx_quote_extension import QuoteNode 

31from .sphinx_nbref_extension import NbRef, NbRefList 

32from .sphinx_postcontents_extension import PostContentsDirective, postcontents_node 

33from .sphinx_tocdelay_extension import TocDelayDirective, tocdelay_node 

34from .sphinx_youtube_extension import YoutubeDirective, youtube_node 

35from .sphinx_sharenet_extension import ShareNetDirective, sharenet_node 

36from .sphinx_downloadlink_extension import process_downloadlink_role 

37from .sphinx_video_extension import VideoDirective, video_node 

38from .sphinx_image_extension import SimpleImageDirective, simpleimage_node 

39from .sphinx_template_extension import tpl_node 

40from .sphinx_todoext_extension import TodoExt, TodoExtList 

41from .documentation_link import python_link_doc 

42 

43from ..sphinxext.sphinx_autosignature import setup as setup_signature 

44from ..sphinxext.sphinx_bigger_extension import setup as setup_bigger 

45from ..sphinxext.sphinx_blocref_extension import setup as setup_blocref 

46from ..sphinxext.sphinx_blog_extension import setup as setup_blog 

47from ..sphinxext.sphinx_collapse_extension import setup as setup_collapse 

48from ..sphinxext.sphinx_gdot_extension import setup as setup_gdot 

49from ..sphinxext.sphinx_cmdref_extension import setup as setup_cmdref 

50from ..sphinxext.sphinx_docassert_extension import setup as setup_docassert 

51from ..sphinxext.sphinx_epkg_extension import setup as setup_epkg 

52from ..sphinxext.sphinx_exref_extension import setup as setup_exref 

53from ..sphinxext.sphinx_faqref_extension import setup as setup_faqref 

54from ..sphinxext.sphinx_githublink_extension import setup as setup_githublink 

55from ..sphinxext.sphinx_gitlog_extension import setup as setup_gitlog 

56from ..sphinxext.sphinx_image_extension import setup as setup_simpleimage 

57from ..sphinxext.sphinx_mathdef_extension import setup as setup_mathdef 

58from ..sphinxext.sphinx_quote_extension import setup as setup_quote 

59from ..sphinxext.sphinx_nbref_extension import setup as setup_nbref 

60from ..sphinxext.sphinx_postcontents_extension import setup as setup_postcontents 

61from ..sphinxext.sphinx_runpython_extension import setup as setup_runpython 

62from ..sphinxext.sphinx_runpython_extension import RunPythonDirective, runpython_node 

63from ..sphinxext.sphinx_sharenet_extension import setup as setup_sharenet 

64from ..sphinxext.sphinx_downloadlink_extension import setup as setup_downloadlink 

65from ..sphinxext.sphinx_template_extension import setup as setup_tpl 

66from ..sphinxext.sphinx_tocdelay_extension import setup as setup_tocdelay 

67from ..sphinxext.sphinx_toctree_extension import setup as setup_toctree 

68from ..sphinxext.sphinx_todoext_extension import setup as setup_todoext 

69from ..sphinxext.sphinx_video_extension import setup as setup_video 

70from ..sphinxext.sphinx_youtube_extension import setup as setup_youtube 

71from ..sphinxext.sphinximages.sphinxtrib.images import setup as setup_image 

72 

73from ..sphinxext.sphinx_doctree_builder import setup as setup_doctree 

74from ..sphinxext.sphinx_latex_builder import setup as setup_latex 

75from ..sphinxext.sphinx_md_builder import setup as setup_md 

76from ..sphinxext.sphinx_rst_builder import setup as setup_rst 

77 

78 

79def get_default_extensions(): 

80 """ 

81 Returns a list of default extensions. 

82 

83 @return list of :epkg:`Sphinx` extensions 

84 

85 The current list is: 

86 

87 .. runpython:: 

88 :showcode: 

89 

90 from pyquickhelper.sphinxext import get_default_extensions 

91 print("\\n".join(get_default_extensions())) 

92 """ 

93 # We delay these imports. 

94 # They change matplotlib backend if executed. 

95 with warnings.catch_warnings(): 

96 warnings.simplefilter("ignore", DeprecationWarning) 

97 from matplotlib.pyplot import get_backend, switch_backend 

98 backend = get_backend() 

99 from matplotlib.sphinxext.plot_directive import setup as setup_plot 

100 backend_ = get_backend() 

101 if backend_ != backend: # pragma: no cover 

102 import matplotlib 

103 try: 

104 with warnings.catch_warnings(record=True): 

105 warnings.simplefilter("error", UserWarning) 

106 matplotlib.use('Agg') 

107 except UserWarning: 

108 import matplotlib.pyplot as plt # pylint: disable=W0611 

109 switch_backend("Agg") 

110 

111 default_setups = [ 

112 setup_toctree, 

113 setup_blog, setup_runpython, setup_sharenet, 

114 setup_todoext, setup_bigger, setup_githublink, 

115 setup_runpython, setup_mathdef, setup_blocref, 

116 setup_faqref, setup_exref, setup_nbref, 

117 setup_docassert, setup_signature, setup_tpl, 

118 setup_cmdref, setup_epkg, setup_rst, setup_md, 

119 setup_latex, setup_doctree, 

120 setup_postcontents, setup_tocdelay, setup_youtube, 

121 # directives from sphinx 

122 setup_graphviz, setup_imgmath, setup_todo, 

123 # the rest of it 

124 setup_autodoc, 

125 setup_plot, setup_image, setup_collapse, setup_gdot, 

126 setup_video, setup_simpleimage, setup_downloadlink, 

127 setup_quote, setup_gitlog] 

128 

129 return [_.__module__ for _ in default_setups] 

130 

131 

132def get_default_standard_extensions(use_mathjax=False): 

133 """ 

134 Returns a list of standard extensions. 

135 

136 @param use_mathjax use :epkg:`mathjax` or :epkg:`imgmath` 

137 @return list of standard extension. 

138 """ 

139 extensions = [ 

140 'sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.coverage', 

141 'sphinx.ext.extlinks', 'sphinx.ext.graphviz', 'sphinx.ext.ifconfig', 

142 'sphinx.ext.inheritance_diagram', 

143 'sphinx.ext.mathjax' if use_mathjax else 'sphinx.ext.imgmath', 

144 'sphinx.ext.napoleon', 'sphinx.ext.todo', 

145 'jupyter_sphinx.execute', 

146 'matplotlib.sphinxext.plot_directive', 

147 ] 

148 

149 return extensions