Skip to content

Commit 1195a3e

Browse files
authored
Merge pull request #13 from tekktrik/docs/update-readme
Update README, .readthedocs.yaml
2 parents 7103071 + 05f9e35 commit 1195a3e

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

.readthedocs.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@
88
# Required
99
version: 2
1010

11+
build:
12+
tools:
13+
python: "3"
14+
1115
python:
12-
version: "3.x"
1316
install:
1417
- requirements: docs/requirements.txt
1518
- requirements: requirements.txt

README.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,15 +121,17 @@ Usage Example
121121
sys.stdout.write("\033[J")
122122
time.sleep(0.05)
123123
124+
Documentation
125+
=============
126+
127+
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ov5640/en/latest/>`_.
128+
129+
For information on building library documentation, please check out
130+
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
131+
124132
Contributing
125133
============
126134

127135
Contributions are welcome! Please read our `Code of Conduct
128136
<https://github.com/adafruit/Adafruit_CircuitPython_ov5640/blob/HEAD/CODE_OF_CONDUCT.md>`_
129137
before contributing to help this project stay welcoming.
130-
131-
Documentation
132-
=============
133-
134-
For information on building library documentation, please check out
135-
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

0 commit comments

Comments
 (0)