注意内容重要内容
Circuit Python 文档
前面已经介绍了 Circuit Python 的内置模块和外部函数库。但是有时这些指南未必能展示出所有功能，而且通常还有更多关于模块或库的内容需要学习。那么，你在哪里可以找到更详细的信息呢？这就是你需要查看 API 文档的时候了。
整个 Circuit Python 项目都有详尽的文档，可在 Read the Docs 上找到。
Circuit Python 核心文档：https://docs.circuitpython.org/en/8.2.x/
CPy库文档：https://docs.circuitpython.org/projects/bundle/en/latest/
Circuit Python 核心文档
Circuit Python 核心文档涵盖了你可能想了解的关于 Circuit Python 核心和相关主题的许多详细信息。它包括 API 和使用信息、设计指南以及有关将 Circuit Python 移植到新板上、与 Circuit Python 相关的 Micro Python 信息，以及有关项目的一般信息。
主页涵盖了基本信息，包括从哪里下载 Circuit Python、如何贡献你的力量、与 Micro Python 的区别、有关项目结构的信息，以及整个文档的完整目录。
使用左侧的列表导航到更多关于特定主题的信息。
第一部分是 API 和使用指南。你可以找到有关如何使用各个内置核心模块的信息，例如时间和数字 I/O，有关支持的端口的详细信息，故障排除建议，以及关于库捆绑包的基本信息和链接。核心模块部分还包括支持矩阵，其中还有一个表格列出了哪些核心模块在哪些板上可用。
第二部分是设计和移植参考。它包括设计指南、架构信息、移植细节和在其他端口中添加模块支持的详细信息。
第三部分是关于 Micro Python 的特变注意事项。它包括与 Micro Python 及相关库有关的信息，以及术语表。
第四部分是关于项目的信息。它包括有关构建、测试和调试 Circuit Python 的详细信息，以及 Adafruit 社区行为准则等各种有用的链接。
无论你是经验丰富的专业人士还是电子和编程的新手，你都可以在文档中找到丰富的信息，以帮助你在 Circuit Python 的旅程中前进！
Circuit Python 库文档
Adafruit Circuit Python 库的文档方式非常前沿。每个库都有自己的 Read the Docs 页面。这里有一个综合列表：https://circuitpython.readthedocs.io/projects/bundle/en/latest/
除此以外，要查看特定库的文档，你可以访问该库的 GitHub ，并在 README 中找到链接。
本页的目的是介绍 LED 动画库的文档。每个库的 GitHub 中都有两个文档链接。第一个是 README 顶部附近的文档徽章。
https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation
第二个位置是 README 的“文档”部分。向下滚动可以找到它，然后单击“Read the Docs”以访问文档。
现在你知道如何查找文档了，是时候看看里面的内容了。
并非所有库文档都看起来完全相同，但这将为你提供一些你想知道的信息。
介绍页面是从 README 自动生成的，因此它包含了所有相同的信息，例如 PyPI 安装说明、快速演示和一些构建细节。它还包含了完整的目录，用于剩余文档（这不是 GitHub README 的一部分）。页面应该看起来类似于下面的样子。
左侧包含链接到文档其余部分的链接，分为三个不同的部分：示例、API 参考和其他链接。
示例
示例部分是一个库示例列表。此列表包含库的示例的从少数几个到全部示例的不等数量。
https://circuitpython.readthedocs.io/projects/led-animation/en/latest/examples.html
这个部分至少包含一个示例 - 简单的测试示例。
简单测试示例通常是一个基本示例，旨在显示你的设置是否正常工作。它可能需要其他库来运行。请注意，它很简单 - 它不会展示库的所有功能的全面使用。
简单测试 Blink 动画
在某些情况下，你会发现一个更长的列表，其中可能包括库中其他功能的示例。LED 动画文档包括一系列示例，所有这些示例都在库中可用。这些示例包括基本功能和更复杂功能的演示。只需单击你感兴趣的示例，即可查看相关的代码。
当示例部分中存在多个链接时，实际上所有的示例内容都位于同一页上。第一个链接之后的每个链接都是指向页面指定部分的锚链接。因此，你也可以通过向下滚动页面来查看所有可用的示例。
要查看示例的其余部分，只需单击列表中的链接或向下滚动页面即可。这些示例是完全可用的代码。也就是说，虽然它们可能依赖于其他库以及你正在查看文档的库，但它们不应需要修改才能正常工作。
API 参考
API 参考部分包括库函数和类的列表。库的 API（应用程序编程接口）是库提供的函数和类的集合。实际上，API 定义了你的程序如何与你在代码中调用的函数和类进行交互，以使用该库。
https://circuitpython.readthedocs.io/projects/led-animation/en/latest/api.html
在这个栏目下始终至少一个列表项。对于将代码包含在单个 Python（.py）文件中的库，只会有一个项目。对于代码位于目录中的多个 Python 文件（称为子包）的库，此列表中将有多个项目。LED 动画库具有一系列子包，因此此列表中有多个项目。
单击列表中的第一个项目以开始查看 API 参考部分。
与示例部分一样，API 参考内容都在单个页面上，并且 API 参考下的链接都是指向页面指定部分的锚链接。
点开API 参考部分中的项目后，你将找到有关库中的类和函数的详细信息。在此部分只有一个项目的情况下，库的所有可用功能都将包含在该部分的第一个子部分中。但是，在具有子包的库的情况下，每个项目都包含与链接指示的特定子包的功能。文档将覆盖库的所有可用功能，包括可能不会引起你兴趣的更复杂功能。
第一个列表项是动画子包。如果向下滚动，你将开始看到动画的可用功能。它们按字母顺序列出。你可以在代码中调用这些内容中的任何内容。它包括你将调用的特定函数的名称和描述，以及如果需要任何参数，则列出参数以及其描述。
你可以通过单击左侧的链接或向下滚动页面来查看其他子包。你可能对更实际的东西感兴趣。这里有一个示例。要使用 LED 动画库的彗星动画，你可以运行以下示例。
//******************分割线******************//
# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
# SPDX-License-Identifier: MIT
"""
This example animates a jade comet that bounces from end to end of the strip.
For QT Py Haxpress and a NeoPixel strip. Update pixel_pin and pixel_num to match your wiring if
using a different board or form of NeoPixels.
This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py
Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket).
"""
import board
import neopixel
from adafruit_led_animation.animation.comet import Comet
from adafruit_led_animation.color import JADE
# Update to match the pin connected to your NeoPixels
pixel_pin = board.A3
# Update to match the number of NeoPixels you have connected
pixel_num = 30
pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.5, auto_write=False)
comet = Comet(pixels, speed=0.02, color=JADE, tail_length=10, bounce=True)
while True:
comet.animate()
//******************分割线******************//
请注意，在创建comet对象的一行中。括号内有许多项。在这种情况下，你提供了一个完全可用的示例。但是，如果你想更改comet的工作方式怎么办？代码本身并没有解释这些选项的含义。
因此，在 API 参考文档列表中，单击adafruit_led_animation.animation.comet链接，向下滚动一点，直到看到以下内容。
这是设置comet对象的文档。它解释了代码中提供的comet设置中的每个参数的含义，以及其他可用的功能。例如，代码speed=0.02。文档说明这是“以秒为单位的动画速度”。代码不包括ring。文档指出这是一个可用的设置，可启用“环模式”。
这种类型的信息对于你在代码中设置的任何函数都是可用的。如果你需要对某些事情有更多的解释，想知道是否有更多的选项可用，或者只是对你编写的代码中涉及的详细信息感兴趣，请查看 Circuit Python 库的文档！
其他链接
这个部分对于每个库都是相同的。它包括指向外部站点的链接列表，你可以访问这些站点以获取有关 Circuit Python 项目和 Adafruit 的更多信息。
这涵盖了 Circuit Python 库文档！当你准备超越指南中介绍的基本库功能，或者你有兴趣更好地理解这些功能时，Read the Docs 上的库文档可以帮助你！
