Notebook Generator 使用教程

Notebook Generator 使用教程

notebook-generator(Auto) generate notebooks from your source code. Useful for ACM-ICPC项目地址:https://gitcode.com/gh_mirrors/no/notebook-generator

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

notebook-generator/
├── README.md
├── notebook_generator.py
├── config.yaml
├── templates/
│   ├── base.tex
│   └── style.tex
├── examples/
│   ├── example1.py
│   └── example2.py
└── tests/
    ├── test_notebook_generator.py
    └── test_config.py

• README.md: 项目介绍和使用说明。
• notebook_generator.py: 项目的主启动文件。
• config.yaml: 项目的配置文件。
• templates/: 包含LaTeX模板文件，用于生成PDF。
• examples/: 包含示例代码文件，用于演示如何生成笔记。
• tests/: 包含测试文件，用于测试项目的功能。

2. 项目的启动文件介绍

notebook_generator.py 是项目的主启动文件，负责读取配置文件、生成笔记内容并输出为PDF文件。以下是该文件的主要功能模块：

import argparse
import yaml
from jinja2 import Environment, FileSystemLoader

def main():
    parser = argparse.ArgumentParser(description="Generate notebooks from source code")
    parser.add_argument("source_dir", help="Directory containing source code files")
    parser.add_argument("-o", "--output", help="Output file for the notebook", default="notebook.pdf")
    parser.add_argument("-c", "--config", help="Configuration file for the notebook", default="config.yaml")
    args = parser.parse_args()

    with open(args.config, 'r') as f:
        config = yaml.safe_load(f)

    env = Environment(loader=FileSystemLoader('templates'))
    template = env.get_template('base.tex')
    rendered_template = template.render(config=config, source_dir=args.source_dir)

    # 生成PDF文件的代码
    # ...

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

config.yaml 是项目的配置文件，用于配置生成笔记的各项参数。以下是该文件的一个示例：

author: "John Doe"
initials: "JD"
font_size: 10
columns: 2
paper_size: "letterpaper"
cover_image: "path/to/cover/image.jpg"

• author: 作者姓名。
• initials: 作者 initials。
• font_size: 字体大小。
• columns: 列数。
• paper_size: 纸张大小。
• cover_image: 封面图片路径。

通过修改 config.yaml 文件，可以自定义生成的笔记的样式和内容。

notebook-generator(Auto) generate notebooks from your source code. Useful for ACM-ICPC项目地址:https://gitcode.com/gh_mirrors/no/notebook-generator