Add new graph

Author: jondy

pyarmor/learn/en/conf.py

@@ -74,12 +74,13 @@
 js_switch_lang = '''
 window.addEventListener("DOMContentLoaded", () => {
     // View page source
-    const element = document.querySelector("ul.wy-breadcrumbs > li.wy-breadcrumbs-aside > a")
+    const element = document.querySelector("ul.this-page-menu > li > a")
     element.innerHTML = "中文"
     element.addEventListener("click", (e) => {
         e.preventDefault()
         window.location.assign(window.location.href.replace("/en/", "/zh/"))
     })
+    document.querySelector('div.sphinxsidebarwrapper > div[aria-label="source link"] > h3').innerHTML = "Language"
 })
 '''
 

pyarmor/learn/en/how-to.rst

@@ -2,11 +2,6 @@
  How to
 ========
 
-.. contents:: Content
-   :depth: 2
-   :local:
-   :backlinks: top
-
 .. highlight:: console
 
 .. _how-to-license:

pyarmor/learn/en/index.rst

@@ -20,8 +20,7 @@ Table of content
 .. toctree::
    :caption: Learning Pyarmor
    :name: learndoc
-   :numbered:
-   :maxdepth: 3
+   :maxdepth: 2
 
    how-to
 

pyarmor/learn/zh/conf.py

@@ -74,12 +74,13 @@
 js_switch_lang = '''
 window.addEventListener("DOMContentLoaded", () => {
     // View page source
-    const element = document.querySelector("ul.wy-breadcrumbs > li.wy-breadcrumbs-aside > a")
+    const element = document.querySelector("ul.this-page-menu > li > a")
     element.innerHTML = "English"
     element.addEventListener("click", (e) => {
         e.preventDefault()
         window.location.assign(window.location.href.replace("/zh/", "/en/"))
     })
+    document.querySelector('div.sphinxsidebarwrapper > div[aria-label="source link"] > h3').innerHTML = "Language"
 })
 '''
 

pyarmor/learn/zh/how-to.rst

@@ -2,11 +2,6 @@
  如何解决问题
 ==============
 
-.. contents:: 目录
-   :depth: 2
-   :local:
-   :backlinks: top
-
 .. highlight:: console
 
 .. _how-to-license:
@@ -45,6 +40,101 @@
 如何解决运行加密脚本过程中出现的问题
 ------------------------------------
 
+.. graphviz::
+   :caption: 运行加密脚本出现问题的解决方案
+   :align: center
+   :name: graph-run-obfuscated-script-issue
+
+   digraph G {
+      node [shape=box, style=rounded]
+
+      start [shape="doublecircle", label="",
+             style="filled", fillcolor="wheat"]
+
+      subgraph P0 {
+          rankdir="TB"
+          style="setlinewidth(0)"
+
+          s1 [label="生成加密脚本的设备和运行加密脚本的设备\n两种是否相同?"]
+          s2 [label="运行脚本的 Python 大小版本和\n生成脚本的 Python 大小版本\n两者是否相同？例如，都是 3.10"]
+          s3 [label="运行结果中是否存在异常错误信息？"]
+          s4 [label="如果使用 RFT 模式进行加密\n尝试禁用 RFT 模式进行加密\n执行加密脚本是否出错？"]
+          s5 [label="如果使用了 BCC 模式进行加密\n尝试禁用 BCC 模式\n执行加密脚本是否出错？"]
+          s6 [label="如果使用了约束选项进行加密\n尝试禁用约束选项进行加密\n执行加密脚本是否出错？"]
+          s7 [label="如果使用了第三方库，先不要使用第三方库\n尝试加密一个简单脚本\n执行加密脚本是否出错？"]
+          s8 [label="如果运行设备上 Python 是 alpha 版\n尝试升级 Python 到最新的小版本\n执行加密脚本是否出错？"]
+
+          s1 -> s2 -> s3
+          s4 -> s5 -> s6 -> s7 -> s8
+      }
+
+      start -> s1
+
+      subgraph P1 {
+          node [
+             style="filled,rounded",
+             fillcolor="burlywood",
+             ]
+          n1 [
+              href="#graph-fix-runtime-cross-platform-issue"
+              label="请参考跨平台发布问题的解决方案"]
+          n2 [
+              href="https://pyarmor.readthedocs.io/zh/latest/tutorial/advanced.html#support-multiple-python-versions"
+              label="请使用相同版本的 Python 加密脚本\n如果需要支持不同版本的 Python\n请参考跨版本发布问题的解决方案"]
+          n3 [href="https://pyarmor.readthedocs.io/zh/latest/reference/errors.html"
+              label="请参考错误信息表查找相应的解决方案"]
+          n4 [style=rounded
+              label="请尝试在脚本中增加 print 语句\n找到导致问题出现的语句"]
+          n5 [href="#graph-fix-runtime-crash-issue"
+              label="请参考运行加密脚本崩溃解决方案"]
+          n6 [
+              href="https://pyarmor.readthedocs.io/zh/latest/topic/rftmode.html"
+              label="请参考 RFT 专题文档"]
+          n7 [
+              href="https://pyarmor.readthedocs.io/zh/latest/topic/bccmode.html"
+              label="请参考 BCC 专题文档"]
+          n8 [href="https://pyarmor.readthedocs.io/zh/latest/reference/man.html#pyarmor-gen"
+              label="详细了解相关选项的使用方法\n使用正确的约束选项\n或者修改脚本满足约束要求"]
+          n9 [href="https://pyarmor.readthedocs.io/zh/latest/how-to/third-party.html"
+              label="请参考常用第三方库解决方案"]
+          n10 [href="https://github.com/dashingsoft/pyarmor/issues"
+               label="提交报告问题，包含\n加密脚本使用的最少选项\n未使用第三方库的测试脚本"]
+      }
+
+      s3 -> n3 [label="有异常"]
+      s3 -> n4 [label="无异常"]
+      s3 -> n5 [label="直接崩溃"]
+      n3 -> s4 [label="未找到解决方案"]
+      s8 -> n10 [label="依旧出错"]
+
+      n4 -> s4
+      n5 -> s4
+
+      edge [tailport=se]
+      s1 -> n1 [label="不相同"]
+      s2 -> n2 [label="不相同"]
+      s4 -> n6 [label="RFT 模式错误"]
+      s5 -> n7 [label="BCC 模式错误"]
+      s6 -> n8 [label="约束模式错误"]
+      s7 -> n9 [label="第三方库错误"]
+   }
+
+.. graphviz::
+   :caption: 跨平台发布加密脚本的解决方案
+   :align: center
+   :name: graph-fix-runtime-cross-platform-issue
+
+   digraph G {
+   }
+
+.. graphviz::
+   :caption: 运行加密脚本崩溃的解决方案
+   :align: center
+   :name: graph-fix-runtime-crash-issue
+
+   digraph G {
+   }
+
 .. _run-packed-script-issue:
 
 如何解决运行打包的可执行文件出现的问题
@@ -68,14 +158,15 @@
           s2 [label="在构建设备上，使用没有加密的脚本\n直接使用 PyInstaller 进行打包\n在客户设备上面运行打包好的可执行文件\n是否出错？"]
           s3 [label="在构建设备上面不要使用 --pack 选项\n而是仅仅加密脚本\n然后在客户设备上面直接运行\n是否依旧出错？"]
           s4 [label="在构建设备上面尝试去掉一些加密选项\n使用最少的加密选项对脚本进行打包\n然后在客户设备运行\n是否出错？"]
-          s5 [label="如果脚本中使用了第三方库\n尝试加密打包一个简单脚本，\n然后在客户设备运行，\n是否出错？"]
-          s6 [
+          s5 [
             style="filled,rounded",
             fillcolor="burlywood",
-            href="https://github.com/dashingsoft/pyarmor/issues"
-            label="提交错误报告\n使用的命令行选项\n以及可以重现问题的简单脚本"]
+            href="https://pyarmor.readthedocs.io/zh/latest/topic/repack.html"
+            label="参考关于打包的详细说明\n使用没有出错的选项进行打包"]
+          s6 [label="如果脚本中使用了第三方库\n尝试加密打包一个简单脚本，\n然后在客户设备运行，\n是否出错？"]
 
-	  s2 -> s3 -> s4 -> s5 -> s6
+	  s2 -> s3 -> s4 -> s5
+          s4 -> s6 [label="出错了", tailport=se]
       }
 
       subgraph P2 {
@@ -91,18 +182,18 @@
             label="请使用加密脚本运行错误的解决方案"]
           n3 [
             href="https://pyarmor.readthedocs.io/zh/latest/how-to/third-party.html"
-            label="查看第三方库是否能够兼容 Pyarmro+PyInstaller"]
-          y1 [
-            href="https://pyarmor.readthedocs.io/zh/latest/topic/repack.html"
-            label="参考关于打包的详细说明\n使用没有出错的选项进行打包"]
+            label="查看第三方库是否能够兼容 Pyarmor+PyInstaller"]
+          n4 [
+            href="https://github.com/dashingsoft/pyarmor/issues"
+            label="提交错误报告，包含\n可以重现问题的最少命令行选项\n可以重现问题的尽可能的简单脚本\n脚本中不要使用第三方包"]
       }
 
       start -> s2
+      s6 -> n3
 
       edge [tailport=se]
 
-      s2 -> n1
-      s3 -> n2
-      s4 -> y1
-      s5 -> n3
+      s2 -> n1 [label="出错了"]
+      s3 -> n2 [label="出错了"]
+      s6 -> n4 [label="出错了" tailport=e]
    }

pyarmor/learn/zh/index.rst

@@ -20,8 +20,7 @@
 .. toctree::
    :caption: 学习 Pyarmor
    :name: learndoc
-   :numbered:
-   :maxdepth: 3
+   :maxdepth: 2
 
    how-to