arXiv LaTeX Cleaner 使用教程

1. 项目的目录结构及介绍

arXiv LaTeX Cleaner 是一个用于清理 LaTeX 代码以提交到 arXiv 的开源工具。以下是该项目的目录结构及其介绍：

arxiv-latex-cleaner/
├── LICENSE
├── MANIFEST.in
├── README.md
├── __init__.py
├── cleaner_config.yaml
├── requirements.txt
├── setup.py
└── tex_zip/
    └── tex_arXiv_true

• LICENSE: 项目许可证文件，采用 Apache 2.0 许可证。
• MANIFEST.in: 用于指定在打包时包含的文件。
• README.md: 项目说明文档。
• __init__.py: Python 包的初始化文件。
• cleaner_config.yaml: 项目的配置文件。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 用于安装项目的脚本。
• tex_zip/: 包含需要清理的 LaTeX 文件的目录。
  • tex_arXiv_true: 示例 LaTeX 文件。

2. 项目的启动文件介绍

项目的启动文件是 setup.py。该文件用于安装和配置项目，可以通过以下命令进行安装：

pip install .

安装完成后，可以使用以下命令启动项目：

arxiv-latex-cleaner <path_to_latex_project>

其中 <path_to_latex_project> 是需要清理的 LaTeX 项目路径。

3. 项目的配置文件介绍

项目的配置文件是 cleaner_config.yaml。该文件包含了清理 LaTeX 代码时的一些配置选项，例如：

# cleaner_config.yaml 示例配置
remove_comments: true
compress_images: true
remove_unused_files: true

• remove_comments: 是否移除 LaTeX 代码中的注释。
• compress_images: 是否压缩图片文件。
• remove_unused_files: 是否移除未使用的文件。

用户可以根据需要修改这些配置选项，以满足不同的清理需求。