Merge pull request #1 from ianhi/docs-test

Fix docs rendering
mpl-extensions · Jun 30, 2021 · 5f40e4e · 5f40e4e
2 parents b1d8222 + 5661db7
commit 5f40e4e
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,11 @@
 
 A multiclass point clicker for matplotlib
 
+![GIF of example usage](docs/_static/images/front-page.apng)
+
+
+Read the [Documentation](https://mpl-point-clicker.readthedocs.io/en/stable)
+
 ## Installation
 
 You can install using `pip`:

diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 author = 'Ian Hunt-Isaak'
 
 # The full version, including alpha/beta/rc tags
-from mpl_point_clicker import __version__ as release
+from _version import __version__ as release
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/mpl_point_clicker/_version.py b/mpl_point_clicker/_version.py
@@ -4,5 +4,5 @@
 # Copyright (c) Ian Hunt-Isaak.
 # Distributed under the terms of the Modified BSD License.
 
-version_info = (0, 1, 0)
+version_info = (0, 1, 1)
 __version__ = ".".join(map(str, version_info))
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -0,0 +1,12 @@
+version: 2
+python:
+    version: 3.8
+    install:
+      - method: pip
+        path: .
+        extra_requirements:
+          - doc
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
diff --git a/setup.cfg b/setup.cfg
@@ -31,6 +31,7 @@ doc =
     sphinx-copybutton
     sphinx-autobuild
     sphinx_gallery>=0.8.2
+    autoapi
 dev =
     %(test)s
     %(doc)s