Merge pull request #83 from dstansby/readthedocs

Add doc hosting on readthedocs

Author: samcunliffe

.readthedocs.yaml

@@ -0,0 +1,15 @@
+version: 2
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  apt_packages:
+    - xvfb

docs/conf.py

@@ -13,7 +13,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-import qtgallery
+# import qtgallery
 
 # -- Project information -----------------------------------------------------
 
@@ -30,18 +30,30 @@
 extensions = [
     "numpydoc",
     "sphinx_gallery.gen_gallery",
+    # "qtgallery",
     "sphinx_automodapi.automodapi",
     "sphinx_automodapi.smart_resolver",
     "sphinx.ext.intersphinx",
 ]
 
 sphinx_gallery_conf = {
-    "filename_pattern": ".",
-    "image_scrapers": (qtgallery.qtscraper,),
-    "reset_modules": (qtgallery.reset_qapp,),
+    # Don't run any gallery examples, because they're not working on
+    # readthedocs at the moment
+    "filename_pattern": "a^",
+    # "image_scrapers": (qtgallery.qtscraper,),
+    # "reset_modules": (qtgallery.reset_qapp,),
 }
 
+
+# qtgallery_conf = {
+#     "xvfb_size": (640, 480),
+#     "xvfb_color_depth": 24,
+#     "xfvb_use_xauth": False,
+#     "xfvb_extra_args": [],
+# }
+
 numpydoc_show_class_members = False
+automodapi_inheritance_diagram = False
 
 intersphinx_mapping = {
     "napari": ("https://napari.org/", None),

setup.cfg

@@ -46,9 +46,9 @@ napari.manifest =
 
 [options.extras_require]
 docs =
+    napari[all]
     numpydoc
     pydata-sphinx-theme
-    qtgallery
     sphinx
     sphinx-automodapi
     sphinx-gallery