Add FAQ entries for DISPLAY and QT_API.

QuLogic · QuLogic · commit 7f6b0b21c5ef · 2019-08-15T02:11:16.000-04:00
diff --git a/doc/faq/environment_variables_faq.rst b/doc/faq/environment_variables_faq.rst
@@ -8,6 +8,13 @@ Environment Variables
    :backlinks: none
 
 
+.. envvar:: DISPLAY
+
+  The server and screen on which to place windows. This is interpreted by GUI
+  toolkits in a backend-specific manner, but generally refers to an `X.org
+  display name
+  <https://www.x.org/releases/X11R7.7/doc/man/man7/X.7.xhtml#heading5>`_.
+
 .. envvar:: HOME
 
   The user's home directory. On linux, :envvar:`~ <HOME>` is shorthand for :envvar:`HOME`.
@@ -36,6 +43,11 @@ Environment Variables
   The list of directories that are added to Python's standard search list when
   importing packages and modules.
 
+.. envvar:: QT_API
+
+   The Python Qt wrapper to prefer when using Qt-based backends. See :ref:`the
+   entry in the usage guide <QT_API-usage>` for more information.
+
 .. _setting-linux-osx-environment-variables:
 
 Setting environment variables in Linux and OS-X
diff --git a/doc/missing-references.json b/doc/missing-references.json
@@ -4977,13 +4977,6 @@
     ]
   },
   "std:envvar": {
-    "QT_API": [
-      "doc/api/prev_api_changes/api_changes_3.1.0.rst:453",
-      "doc/tutorials/introductory/usage.rst:592"
-    ],
-    "DISPLAY": [
-      "doc/tutorials/introductory/usage.rst:411"
-    ],
     "CC": [
       "INSTALL.rst:93",
       "doc/users/prev_whats_new/whats_new_1.5.rst:737"
diff --git a/tutorials/introductory/usage.py b/tutorials/introductory/usage.py
@@ -482,6 +482,8 @@ def my_plotter(ax, data1, data2, param_dict):
 # ``GTK3`` backends (*both* ``GTK3Agg`` and ``GTK3Cairo``) depend on Cairo
 # (pycairo>=1.11.0 or cairocffi).
 #
+# .. _QT_API-usage:
+#
 # How do I select PyQt4 or PySide?
 # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 #

Original file line number	Diff line number	Diff line change
`@@ -482,6 +482,8 @@ def my_plotter(ax, data1, data2, param_dict):`
`482`	`482`	# ``GTK3`` backends (both ``GTK3Agg`` and ``GTK3Cairo``) depend on Cairo
`483`	`483`	`# (pycairo>=1.11.0 or cairocffi).`
`484`	`484`	`#`
	`485`	`+# .. _QT_API-usage:`
	`486`	`+#`
`485`	`487`	`# How do I select PyQt4 or PySide?`
`486`	`488`	`# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^`
`487`	`489`	`#`