Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Update README, .readthedocs.yaml #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 29, 2022
Merged

Update README, .readthedocs.yaml #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7f9d59a
Update .readthedocs.yaml to fix Python version selection
tekktrik Jan 29, 2022
cd2787c
Update README to include link to documentation
tekktrik Jan 29, 2022
b4a4e90
Move Documentation section above Contributing section
tekktrik Jan 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@
# Required
version: 2

build:
tools:
python: "3"

python:
version: "3.x"
install:
- requirements: docs/requirements.txt
- requirements: requirements.txt
14 changes: 8 additions & 6 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,17 @@ Or the following command to update an existing version:

circup update

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://circuitpython.readthedocs.io/en/latest/docs/library/asyncio.html>`_.

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_asyncio/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>`_.