============================
 Pyarmor |version| 用户文档
============================

:版本: |release|
:主页: |Website|
:邮箱: |Contact|
:作者: |Author|

如何阅读本手册
==============

|Pyarmor| 有完备的文档系统，这里是帮助用户如何快速找到需要的相关内容

* :doc:`第一部分: 基础教程 <part-1>` 适合第一次使用 Pyarmor 的用户，这里以实例的形式一步接着一步的说明了加密脚本和包的最常用的场景。也可以先看看 :doc:`tutorial/getting-started`

* :doc:`第二部分: 应用实践 <part-2>` 针对每一个特定的需求，说明在 Pyarmor 中应该如何去做，使用什么样的命令和选项去实现。阅读这部分内容需要对 Pyarmor 和 Python 都有一定的了解。

* :doc:`第三部分: 技术手册 <part-3>` 从技术层的角度详细列出了所有的概念定义，命令手册，配置选项和错误信息代码。它适用于使用 Pyarmor 的高级用户，需要查找相关的参数和配置，了解这些配置项的可用值和不同值的作用和含义。

* :doc:`第四部分: 深入了解 <part-4>` 这部分针对 Pyarmor 提供的功能，从如何实现的层面进行了详细的解释。阅读这部分内容需要完全掌握了 Pyarmor 使用到的主要概念，以及对 Python 脚本的执行过程有相当了解。它适用于需要对 Pyarmor 进行扩展和定制，以满足更高一层需求的用户。

* :doc:`第五部分: 许可模式和许可证类型 <licenses>` 描述了 |Pyarmor| 的最终用户许可协议， |Pyarmor| 的许可模式，不同的许可类型，以及如何购买 |Pyarmor| 许可证。

.. important::

   Pyarmor 9.1.0 中新增功能的文档目前发布在新的 Pyarmor 学习系统

   https://eke.dashingsoft.com/pyarmor/docs/zh/index.html

   包括三个新命令: `pyarmor init`, `pyarmor env`, `pyarmor build`

   以及新的加密脚本类型: `rft`, `mini`, `vmc`, `ecc`

获取帮助
========

使用中遇到问题？

那么首先看看 :doc:`常见问题 <questions>` – 这里详细说明了对于常见问题的通用解决方法，大部分的用户问题按照通用方法的步骤，都可以得到解决。后面的章节则分类列出了用户经常提问的一些问题和解决方案，使用过程中出现问题来这里通常是最快的解决方式。

想找某一个特定的关键字，搜一下 :ref:`总索引 <genindex>`, 或者浏览 :ref:`文档总目录 <mastertoc>`

还是没有找到？ 看一下 :ref:`如何在 Github 上提问 <asking questions>`.

发现 Pyarmor_ 的问题，请点击 `问题报告`_ 按照模版进行提交。

目录
====

.. toctree::
   :numbered:
   :maxdepth: 3
   :name: mastertoc

   part-1
   part-2
   part-3
   part-4
   licenses
   questions

索引表
======

* :ref:`总索引 <genindex>`
* :ref:`模块索引 <modindex>`
* :ref:`搜索 <search>`

.. include:: _common_definitions.txt