Skip to content

Commit 19f0ce9

Browse files
authored
Merge pull request #16 from tekktrik/docs/update-readme
Update README, .readthedocs.yaml
2 parents edfa7c2 + b4a4e90 commit 19f0ce9

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

.readthedocs.yaml

+4-1
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

+8-6
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,17 @@ Or the following command to update an existing version:
6969
7070
circup update
7171
72+
Documentation
73+
=============
74+
75+
API documentation for this library can be found on `Read the Docs <https://circuitpython.readthedocs.io/en/latest/docs/library/asyncio.html>`_.
76+
77+
For information on building library documentation, please check out
78+
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
79+
7280
Contributing
7381
============
7482

7583
Contributions are welcome! Please read our `Code of Conduct
7684
<https://github.com/adafruit/Adafruit_CircuitPython_asyncio/blob/HEAD/CODE_OF_CONDUCT.md>`_
7785
before contributing to help this project stay welcoming.
78-
79-
Documentation
80-
=============
81-
82-
For information on building library documentation, please check out
83-
`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)