Skip to content

Commit a115fc3

Browse files
authored
Merge pull request #123 from tekktrik/docs/update-readme
Update README, .readthedocs.yaml
2 parents 5ac4d4a + 182448a commit a115fc3

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
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.6"
1316
install:
1417
- requirements: docs/requirements.txt
1518
- requirements: requirements.txt

README.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,16 @@ need to be specified as it is computed from the supplied ``pixel_order``.
106106
pixel = neopixel.NeoPixel(board.D0, 1, pixel_order=neopixel.RGBW)
107107
pixel[0] = (30, 0, 20, 10)
108108
109+
Documentation
110+
=============
111+
112+
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/neopixel/en/latest/>`_.
113+
114+
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>`_.
109115

110116
Contributing
111117
============
112118

113119
Contributions are welcome! Please read our `Code of Conduct
114120
<https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/main/CODE_OF_CONDUCT.md>`_
115121
before contributing to help this project stay welcoming.
116-
117-
Documentation
118-
=============
119-
120-
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>`_.

0 commit comments

Comments
 (0)