Skip to content

Commit 3f712bf

Browse files
authored
Merge pull request #2 from tekktrik/docs/update-readme
Update README, .readthedocs.yaml
2 parents 12b0e9a + 48e5677 commit 3f712bf

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
@@ -98,15 +98,17 @@ Usage Example
9898

9999
See examples/vl53l1x_simpletest.py for basic usage example.
100100

101+
Documentation
102+
=============
103+
104+
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopixel/en/latest/>`_.
105+
106+
For information on building library documentation, please check out
107+
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
108+
101109
Contributing
102110
============
103111

104112
Contributions are welcome! Please read our `Code of Conduct
105113
<https://github.com/adafruit/Adafruit_CircuitPython_VL53L1X/blob/HEAD/CODE_OF_CONDUCT.md>`_
106114
before contributing to help this project stay welcoming.
107-
108-
Documentation
109-
=============
110-
111-
For information on building library documentation, please check out
112-
`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)