Skip to content

Commit 607627a

Browse files
committed
fix docs
1 parent 1b623da commit 607627a

File tree

3 files changed

+4
-45
lines changed

3 files changed

+4
-45
lines changed

README.rst

+3-39
Original file line numberDiff line numberDiff line change
@@ -33,42 +33,12 @@ This is easily achieved by downloading
3333
or individual libraries can be installed using
3434
`circup <https://github.com/adafruit/circup>`_.
3535

36-
.. todo:: Describe the Adafruit product this library works with. For PCBs, you can also add the
37-
image from the assets folder in the PCB's GitHub repo.
38-
39-
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
40-
4136

4237
Installing from PyPI
4338
=====================
44-
.. note:: This library is not available on PyPI yet. Install documentation is included
45-
as a standard element. Stay tuned for PyPI availability!
46-
47-
.. todo:: Remove the above note if PyPI version is/will be available at time of release.
48-
49-
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
50-
PyPI <https://pypi.org/project/adafruit-circuitpython-asyncio/>`_.
51-
To install for current user:
52-
53-
.. code-block:: shell
54-
55-
pip3 install adafruit-circuitpython-asyncio
56-
57-
To install system-wide (this may be required in some cases):
58-
59-
.. code-block:: shell
60-
61-
sudo pip3 install adafruit-circuitpython-asyncio
62-
63-
To install in a virtual environment in your current project:
64-
65-
.. code-block:: shell
66-
67-
mkdir project-name && cd project-name
68-
python3 -m venv .env
69-
source .env/bin/activate
70-
pip3 install adafruit-circuitpython-asyncio
71-
39+
This library is meant to be a subset of the ` ``asyncio`` module in CPython
40+
<https://docs.python.org/3/library/asyncio.html>`_, and will not be made available on PyPI.
41+
Use the CPython version instead.
7242

7343

7444
Installing to a Connected CircuitPython Device with Circup
@@ -94,12 +64,6 @@ Or the following command to update an existing version:
9464
9565
circup update
9666
97-
Usage Example
98-
=============
99-
100-
.. todo:: Add a quick, simple example. It and other examples should live in the
101-
examples folder and be included in docs/examples.rst.
102-
10367
Contributing
10468
============
10569

docs/index.rst

-6
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,9 @@ Table of Contents
2424
.. toctree::
2525
:caption: Tutorials
2626

27-
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
28-
the toctree above for use later.
29-
3027
.. toctree::
3128
:caption: Related Products
3229

33-
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
34-
the toctree above for use later.
35-
3630
.. toctree::
3731
:caption: Other Links
3832

requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
# SPDX-License-Identifier: MIT
55

66
Adafruit-Blinka
7+
adafruit-circuitpython-ticks

0 commit comments

Comments
 (0)