2828
2929# Add any Sphinx extension module names here, as strings. They can be extensions
3030# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
31- extensions = ['matplotlib.sphinxext.mathmpl' ,'sphinxext.math_symbol_table' ,
32- 'sphinx.ext.autodoc' ,'matplotlib.sphinxext.only_directives' ,
33- 'sphinx.ext.doctest' ,'sphinx.ext.autosummary' ,
34- 'sphinx.ext.inheritance_diagram' ,'sphinx.ext.intersphinx' ,
35- 'sphinx_gallery.gen_gallery' ,
36- 'matplotlib.sphinxext.plot_directive' ,
37- 'sphinxext.github' ,
38- 'numpydoc' ]
31+ extensions = [
32+ 'sphinx.ext.autodoc' ,
33+ 'sphinx.ext.autosummary' ,
34+ 'sphinx.ext.doctest' ,
35+ 'sphinx.ext.inheritance_diagram' ,
36+ 'sphinx.ext.intersphinx' ,
37+ 'IPython.sphinxext.ipython_console_highlighting' ,
38+ 'IPython.sphinxext.ipython_directive' ,
39+ 'numpydoc' ,# Needs to be loaded *after* autodoc.
40+ 'sphinx_gallery.gen_gallery' ,
41+ 'matplotlib.sphinxext.mathmpl' ,
42+ 'matplotlib.sphinxext.only_directives' ,
43+ 'matplotlib.sphinxext.plot_directive' ,
44+ 'sphinxext.github' ,
45+ 'sphinxext.math_symbol_table' ,
46+ 'sphinxext.mock_gui_toolkits' ,
47+ 'sphinxext.skip_deprecated' ,
48+ ]
3949
4050exclude_patterns = ['api/api_changes/*' ,'users/whats_new/*' ]
4151
@@ -60,19 +70,9 @@ def _check_deps():
6070"The following dependencies are missing to build the "
6171"documentation: {}" .format (", " .join (missing )))
6272
63-
6473_check_deps ()
6574
6675import matplotlib
67- try :
68- from unittest .mock import MagicMock
69- except ImportError :
70- from mock import MagicMock
71-
72-
73- # Use IPython's console highlighting by default
74- extensions .extend (['IPython.sphinxext.ipython_console_highlighting' ,
75- 'IPython.sphinxext.ipython_directive' ])
7676
7777if six .PY2 :
7878from distutils .spawn import find_executable
@@ -85,7 +85,6 @@ def _check_deps():
8585"No binary named dot - you need to install the Graph Visualization "
8686"software (usually packaged as 'graphviz') to build the documentation" )
8787
88-
8988autosummary_generate = True
9089
9190autodoc_docstring_signature = True
@@ -341,143 +340,7 @@ def _check_deps():
341340]
342341
343342
344- class MyWX (MagicMock ):
345- class Panel (object ):
346- pass
347-
348- class ToolBar (object ):
349- pass
350-
351- class Frame (object ):
352- pass
353-
354- VERSION_STRING = '2.8.12'
355-
356-
357- class MyPyQt4 (MagicMock ):
358- class QtGui (object ):
359- # PyQt4.QtGui public classes.
360- # Generated with
361- # textwrap.fill([name for name in dir(PyQt4.QtGui)
362- # if isinstance(getattr(PyQt4.QtGui, name), type)])
363- _QtGui_public_classes = """\
364-
365- QAbstractItemDelegate QAbstractItemView QAbstractPrintDialog
366- QAbstractProxyModel QAbstractScrollArea QAbstractSlider
367- QAbstractSpinBox QAbstractTextDocumentLayout QAction QActionEvent
368- QActionGroup QApplication QBitmap QBoxLayout QBrush QButtonGroup
369- QCalendarWidget QCheckBox QClipboard QCloseEvent QColor QColorDialog
370- QColumnView QComboBox QCommandLinkButton QCommonStyle QCompleter
371- QConicalGradient QContextMenuEvent QCursor QDataWidgetMapper QDateEdit
372- QDateTimeEdit QDesktopServices QDesktopWidget QDial QDialog
373- QDialogButtonBox QDirModel QDockWidget QDoubleSpinBox QDoubleValidator
374- QDrag QDragEnterEvent QDragLeaveEvent QDragMoveEvent QDropEvent
375- QErrorMessage QFileDialog QFileIconProvider QFileOpenEvent
376- QFileSystemModel QFocusEvent QFocusFrame QFont QFontComboBox
377- QFontDatabase QFontDialog QFontInfo QFontMetrics QFontMetricsF
378- QFormLayout QFrame QGesture QGestureEvent QGestureRecognizer QGlyphRun
379- QGradient QGraphicsAnchor QGraphicsAnchorLayout QGraphicsBlurEffect
380- QGraphicsColorizeEffect QGraphicsDropShadowEffect QGraphicsEffect
381- QGraphicsEllipseItem QGraphicsGridLayout QGraphicsItem
382- QGraphicsItemAnimation QGraphicsItemGroup QGraphicsLayout
383- QGraphicsLayoutItem QGraphicsLineItem QGraphicsLinearLayout
384- QGraphicsObject QGraphicsOpacityEffect QGraphicsPathItem
385- QGraphicsPixmapItem QGraphicsPolygonItem QGraphicsProxyWidget
386- QGraphicsRectItem QGraphicsRotation QGraphicsScale QGraphicsScene
387- QGraphicsSceneContextMenuEvent QGraphicsSceneDragDropEvent
388- QGraphicsSceneEvent QGraphicsSceneHelpEvent QGraphicsSceneHoverEvent
389- QGraphicsSceneMouseEvent QGraphicsSceneMoveEvent
390- QGraphicsSceneResizeEvent QGraphicsSceneWheelEvent
391- QGraphicsSimpleTextItem QGraphicsTextItem QGraphicsTransform
392- QGraphicsView QGraphicsWidget QGridLayout QGroupBox QHBoxLayout
393- QHeaderView QHelpEvent QHideEvent QHoverEvent QIcon QIconDragEvent
394- QIconEngine QIconEngineV2 QIdentityProxyModel QImage QImageIOHandler
395- QImageReader QImageWriter QInputContext QInputContextFactory
396- QInputDialog QInputEvent QInputMethodEvent QIntValidator QItemDelegate
397- QItemEditorCreatorBase QItemEditorFactory QItemSelection
398- QItemSelectionModel QItemSelectionRange QKeyEvent QKeyEventTransition
399- QKeySequence QLCDNumber QLabel QLayout QLayoutItem QLineEdit
400- QLinearGradient QListView QListWidget QListWidgetItem QMainWindow
401- QMatrix QMatrix2x2 QMatrix2x3 QMatrix2x4 QMatrix3x2 QMatrix3x3
402- QMatrix3x4 QMatrix4x2 QMatrix4x3 QMatrix4x4 QMdiArea QMdiSubWindow
403- QMenu QMenuBar QMessageBox QMimeSource QMouseEvent
404- QMouseEventTransition QMoveEvent QMovie QPageSetupDialog QPaintDevice
405- QPaintEngine QPaintEngineState QPaintEvent QPainter QPainterPath
406- QPainterPathStroker QPalette QPanGesture QPen QPicture QPictureIO
407- QPinchGesture QPixmap QPixmapCache QPlainTextDocumentLayout
408- QPlainTextEdit QPolygon QPolygonF QPrintDialog QPrintEngine
409- QPrintPreviewDialog QPrintPreviewWidget QPrinter QPrinterInfo
410- QProgressBar QProgressDialog QProxyModel QPushButton QPyTextObject
411- QQuaternion QRadialGradient QRadioButton QRawFont QRegExpValidator
412- QRegion QResizeEvent QRubberBand QScrollArea QScrollBar
413- QSessionManager QShortcut QShortcutEvent QShowEvent QSizeGrip
414- QSizePolicy QSlider QSortFilterProxyModel QSound QSpacerItem QSpinBox
415- QSplashScreen QSplitter QSplitterHandle QStackedLayout QStackedWidget
416- QStandardItem QStandardItemModel QStaticText QStatusBar
417- QStatusTipEvent QStringListModel QStyle QStyleFactory QStyleHintReturn
418- QStyleHintReturnMask QStyleHintReturnVariant QStyleOption
419- QStyleOptionButton QStyleOptionComboBox QStyleOptionComplex
420- QStyleOptionDockWidget QStyleOptionDockWidgetV2 QStyleOptionFocusRect
421- QStyleOptionFrame QStyleOptionFrameV2 QStyleOptionFrameV3
422- QStyleOptionGraphicsItem QStyleOptionGroupBox QStyleOptionHeader
423- QStyleOptionMenuItem QStyleOptionProgressBar QStyleOptionProgressBarV2
424- QStyleOptionRubberBand QStyleOptionSizeGrip QStyleOptionSlider
425- QStyleOptionSpinBox QStyleOptionTab QStyleOptionTabBarBase
426- QStyleOptionTabBarBaseV2 QStyleOptionTabV2 QStyleOptionTabV3
427- QStyleOptionTabWidgetFrame QStyleOptionTabWidgetFrameV2
428- QStyleOptionTitleBar QStyleOptionToolBar QStyleOptionToolBox
429- QStyleOptionToolBoxV2 QStyleOptionToolButton QStyleOptionViewItem
430- QStyleOptionViewItemV2 QStyleOptionViewItemV3 QStyleOptionViewItemV4
431- QStylePainter QStyledItemDelegate QSwipeGesture QSyntaxHighlighter
432- QSystemTrayIcon QTabBar QTabWidget QTableView QTableWidget
433- QTableWidgetItem QTableWidgetSelectionRange QTabletEvent
434- QTapAndHoldGesture QTapGesture QTextBlock QTextBlockFormat
435- QTextBlockGroup QTextBlockUserData QTextBrowser QTextCharFormat
436- QTextCursor QTextDocument QTextDocumentFragment QTextDocumentWriter
437- QTextEdit QTextFormat QTextFragment QTextFrame QTextFrameFormat
438- QTextImageFormat QTextInlineObject QTextItem QTextLayout QTextLength
439- QTextLine QTextList QTextListFormat QTextObject QTextObjectInterface
440- QTextOption QTextTable QTextTableCell QTextTableCellFormat
441- QTextTableFormat QTimeEdit QToolBar QToolBox QToolButton QToolTip
442- QTouchEvent QTransform QTreeView QTreeWidget QTreeWidgetItem
443- QTreeWidgetItemIterator QUndoCommand QUndoGroup QUndoStack QUndoView
444- QVBoxLayout QValidator QVector2D QVector3D QVector4D QWhatsThis
445- QWhatsThisClickedEvent QWheelEvent QWidget QWidgetAction QWidgetItem
446- QWindowStateChangeEvent QWizard QWizardPage QWorkspace
447- QX11EmbedContainer QX11EmbedWidget QX11Info
448- """
449- for _name in _QtGui_public_classes .split ():
450- locals ()[_name ]= type (_name , (), {})
451- del _name
452-
453-
454- class MySip (MagicMock ):
455- def getapi (* args ):
456- return 1
457-
458-
459- mockwxversion = MagicMock ()
460- mockwx = MyWX ()
461- mocksip = MySip ()
462- mockpyqt4 = MyPyQt4 ()
463- sys .modules ['wxversion' ]= mockwxversion
464- sys .modules ['wx' ]= mockwx
465- sys .modules ['sip' ]= mocksip
466- sys .modules ['PyQt4' ]= mockpyqt4
467343
468344# numpydoc config
469345
470346numpydoc_show_class_members = False
471-
472- # Skip deprecated members
473-
474- def skip_deprecated (app ,what ,name ,obj ,skip ,options ):
475- if skip :
476- return skip
477- skipped = {"matplotlib.colors" : ["ColorConverter" ,"hex2color" ,"rgb2hex" ]}
478- skip_list = skipped .get (getattr (obj ,"__module__" ,None ))
479- if skip_list is not None :
480- return getattr (obj ,"__name__" ,None )in skip_list
481-
482- def setup (app ):
483- app .connect ('autodoc-skip-member' ,skip_deprecated )