Skip to content

Commit 66c7a11

Browse files
committed
Translate english doc
1 parent 377c23e commit 66c7a11

File tree

13 files changed

+278
-499
lines changed

13 files changed

+278
-499
lines changed

pyarmor/docs/gendoc.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# -*- coding: utf-8 -*-
33
#
44

5-
"""根据设计文档生成用户手册"""
5+
"""Generate user doc"""
66

77
import argparse
88
import logging

pyarmor/docs/index.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
Pyarmor |version| Documentation
7-
===============================
6+
.. important::
7+
8+
Here only includes Pyarmor 9.1 new features, other functions please check `Pyarmor 9.0 Documentation <https://pyarmor.readthedocs.io/en/latest/>`_
9+
10+
Table of Contents
11+
=================
812

913
.. toctree::
14+
:numbered:
1015
:maxdepth: 2
11-
:caption: Content
1216

1317
user/features
1418
user/concepts

pyarmor/docs/reference/platforms.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
Platforms
33
===========
44

5-
支持的 Python 版本,操作系统,CPU 架构
5+
Python 3.7~3.13
66

7-
支持的 Python 解释器,CPython, IPython, WASM 等等
7+
Windows, Linux, Darwin, FreeBSD etc.

pyarmor/docs/reference/ranges.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
11
========
22
Ranges
33
========
4-
5-
支持的有效值的范围
6-
7-
譬如
8-
9-
VMC 模式中 for 语句最大的嵌套层数目前支持的是 8 层
10-
VMC 模式中最大的变量数目是 2 的 32 次幂

pyarmor/docs/user/concepts.rst

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,46 @@
11
============
2-
概念和定义
2+
Concepts
33
============
44

5-
.. contents:: 目录
5+
.. contents:: Content
66
:depth: 2
77
:local:
88
:backlinks: top
99

1010
.. highlight:: console
1111

12-
术语表
13-
======
12+
Terms
13+
=====
1414

1515
.. glossary::
1616

17-
工程
18-
工程是用来组织需要加密的脚本和如何加密脚本的选项集合
17+
Project
18+
Project is used to manage scripts and options
1919

20-
迷你型脚本
21-
使用 :term:`pyarmor` 命令生成的一种加密脚本,需要扩展模块 :term:`pyarmor_mini` 才能正常运行
20+
Mini Script
21+
Python script, generated by :term:`pyarmor`
2222

23-
重构型脚本
24-
使用 :term:`pyarmor` 命令生成的加密脚本,主要是对脚本中函数,类和方法等名称进行了重命名,不需要任何额外的扩展模块即可运行
23+
It need import Python extension :term:`pyarmor_mini` to run
24+
25+
RFT Script
26+
Python script, generated by :term:`pyarmor`, only functions, classes, attributes etc. in the scripts are renamed
27+
28+
It need not any other extension to run
2529

2630
pyarmor
27-
实现 Pyarmor 所有功能的命令行工具
31+
One cli application to generate obfuscated scripts
2832

2933
pyarmor_mini
30-
Python 扩展模块,由 Pyarmor 开发组预编译,并发布在包 :term:`pyarmor.mini`
34+
Python extension, published in PyPI package :term:`pyarmor.mini`
3135

3236
pyarmor.cli
33-
Python 包,用来创建 :term:`pyarmor` ,由 Pyarmor 开发组发布
37+
Python package, published in PyPI
3438

3539
pyarmor.mini
36-
Python 包,提供运行加密脚本需要的预编译扩展模块,由 Pyarmor 开发组发布在 PyPI 上面
40+
Python package, published in PyPI, provide extension :term:`pyarmor_mini`
3741

38-
工程
39-
====
42+
Project
43+
=======
4044

4145
.. graphviz::
4246

@@ -52,17 +56,17 @@
5256

5357
}
5458

55-
迷你型加密脚本
56-
==============
59+
Mini Script
60+
===========
5761

5862
.. code:: python
5963
6064
from pyarmor_mini import __pyarmor__
6165
__pyarmor__(__name__, b'xxxx')
6266
6367
64-
重构型加密脚本
65-
==============
68+
RFT Script
69+
==========
6670

6771
.. code:: python
6872
@@ -71,8 +75,8 @@
7175
7276
pyarmor__1('abc')
7377
74-
pyarmor 命令
75-
==============
78+
pyarmor commands
79+
================
7680

7781
.. graphviz::
7882

@@ -84,31 +88,31 @@ pyarmor 命令
8488
C3 [label="pyarmor build"]
8589
}
8690

87-
功能结构图
88-
==========
91+
Function Diagram
92+
================
8993

9094
.. graphviz::
9195

9296
digraph Structure {
9397

94-
P1 [label="工程" shape=component]
98+
P1 [label="Project" shape=component]
9599

96100
C1 [label="pyarmor init" shape=rect]
97101
C2 [label="pyarmor env" shape=rect]
98102
C3 [label="pyarmor build" shape=rect]
99103

100-
X1 [label="选项"]
104+
X1 [label="Options"]
101105

102-
S1 [label="迷你型脚本" shape=component]
103-
S2 [label="重构型脚本" shape=component]
106+
S1 [label="Mini Script" shape=component]
107+
S2 [label="RFT Script" shape=component]
104108

105109
X1->C1
106-
C1->P1 [taillabel="创建"]
110+
C1->P1 [taillabel="create"]
107111

108112
X1->C2
109-
C2->P1 [taillabel="修改"]
113+
C2->P1 [taillabel="update"]
110114

111115
P1->C3
112-
C3->S1 [label="生成" labelfloat=true]
116+
C3->S1 [label="generate" labelfloat=true]
113117
C3->S2
114118
}

0 commit comments

Comments
 (0)