文档
========

欢迎阅读ADM项目的代码文档，这部分详细记录了所有使用代码的文本字符串生成\
的API参考文档，以及对应的详细说明。

该部分力求准确与完整，并且与最新的内容保持同步。

.. seealso::
    代码文档侧重于功能的代码实现本身，因此可能并不易作为实际使用时的参考，\
    如果你仅需了解如何使用项目，不妨看看\ :hoverxref:`快速上手 <usage>`\
    了解一下项目的基本信息，或者查看\ :hoverxref:`用户指南 <guides>`\
    获取更适用于实际使用的参考手册。

项目结构
--------

ADM项目是由如下三个部分构成的：

+ **core**:
    ADM项目的核心部分的实现，负责所有实际的代码逻辑，所有与网络和文件的直接\
    访问均由该部分实现

+ **website**:
    ADM项目的Web端的实现，负责所有网页的代码逻辑，主要负责网站相关的操作包装

+ **gui**:
    ADM项目的GUI界面的实现，负责所有UI的代码逻辑，与 **website** 的行为类似

此外ADM项目通过启动层初始化以上内容，并执行额外的初始化操作和最外层的异常捕捉。

.. warning::
    当前的 **website** 和 **gui** 部分的开发尚未开始，相关文档仅供参考

------

.. toctree::
    :maxdepth: 3

    docs/setup
    docs/core/main
    docs/website/main
    docs/gui/main