Merge pull request #4 from tekktrik/docs/update-readme

Update README, .readthedocs.yaml
This commit is contained in:
Dan Halbert 2022-01-30 08:51:40 -05:00 committed by GitHub
commit fc27dd9365
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 7 deletions

View file

@ -8,8 +8,11 @@
# Required
version: 2
build:
tools:
python: "3"
python:
version: "3.6"
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt

View file

@ -101,15 +101,17 @@ Usage Example
while ticks_less(ticks_ms(), deadline):
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ticks/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_ticks/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Documentation
=============
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>`_.