Merge pull request #13 from tekktrik/docs/update-readme

Update README, .readthedocs.yaml
adafruit · Jan 29, 2022 · 1195a3e · 1195a3e
2 parents 7103071 + 05f9e35
commit 1195a3e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,8 +8,11 @@
 # Required
 version: 2
 
+build:
+  tools:
+    python: "3"
+
 python:
-  version: "3.x"
   install:
     - requirements: docs/requirements.txt
     - requirements: requirements.txt
diff --git a/README.rst b/README.rst
@@ -121,15 +121,17 @@ Usage Example
         sys.stdout.write("\033[J")
         time.sleep(0.05)
 
+Documentation
+=============
+
+API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ov5640/en/latest/>`_.
+
+For information on building library documentation, please check out
+`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
+
 Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_ov5640/blob/HEAD/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
-
-Documentation
-=============
-
-For information on building library documentation, please check out
-`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.