Skip to content

Commit fc27dd9

Browse files
authored
Merge pull request #4 from tekktrik/docs/update-readme
Update README, .readthedocs.yaml
2 parents 272b6cc + c48a0c5 commit fc27dd9

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.6"
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
@@ -101,15 +101,17 @@ Usage Example
101101
while ticks_less(ticks_ms(), deadline):
102102
pass
103103
104+
Documentation
105+
=============
106+
107+
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ticks/en/latest/>`_.
108+
109+
For information on building library documentation, please check out
110+
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
111+
104112
Contributing
105113
============
106114

107115
Contributions are welcome! Please read our `Code of Conduct
108116
<https://github.com/adafruit/Adafruit_CircuitPython_ticks/blob/HEAD/CODE_OF_CONDUCT.md>`_
109117
before contributing to help this project stay welcoming.
110-
111-
Documentation
112-
=============
113-
114-
For information on building library documentation, please check out
115-
`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)