Merge pull request #1201 from pyqtgraph/rtd_build

Get readthedocs working

.readthedocs.yml

@@ -0,0 +1,12 @@
+# Read the Docs configuration file
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+python:
+  version: 3
+  install:
+    - requirements: doc/requirements.txt
+
+sphinx:
+  fail_on_warning: true

README.md

@@ -1,5 +1,6 @@
 
 [![Build Status](https://pyqtgraph.visualstudio.com/pyqtgraph/_apis/build/status/pyqtgraph.pyqtgraph?branchName=develop)](https://pyqtgraph.visualstudio.com/pyqtgraph/_build/latest?definitionId=17&branchName=develop)
+[![Documentation Status](https://readthedocs.org/projects/pyqtgraph/badge/?version=latest)](https://pyqtgraph.readthedocs.io/en/latest/?badge=latest)
 
 PyQtGraph
 =========
@@ -72,4 +73,4 @@ Documentation
 
 The easiest way to learn pyqtgraph is to browse through the examples; run `python -m pyqtgraph.examples` for a menu.
 
-The official documentation lives at http://pyqtgraph.org/documentation
+The official documentation lives at https://pyqtgraph.readthedocs.io

doc/requirements.txt

@@ -0,0 +1,5 @@
+pyside2
+numpy
+pyopengl
+sphinx
+sphinx_rtd_theme

doc/source/conf.py

@@ -88,6 +88,12 @@ pygments_style = 'sphinx'
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
+autodoc_inherit_docstrings = False
+autodoc_mock_imports = [
+    "scipy",
+    "h5py",
+    "matplotlib",
+]
 
 # -- Options for HTML output ---------------------------------------------------
 
@@ -122,7 +128,7 @@ html_theme = 'sphinx_rtd_theme'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

pyqtgraph/graphicsItems/PlotItem/PlotItem.py

@@ -290,7 +290,7 @@ class PlotItem(GraphicsWidget):
         Place axis items as given by `axisItems`. Initializes non-existing axis items.
         
         ==============  ==========================================================================================
-        **Arguments:**<
+        **Arguments:**
         *axisItems*     Optional dictionary instructing the PlotItem to use pre-constructed items
                         for its axes. The dict keys must be axis names ('left', 'bottom', 'right', 'top')
                         and the values must be instances of AxisItem (or at least compatible with AxisItem).