RainaDoc

目录

  • 系统概述
  • 使用方法
  • XML 命令定义格式
  • RST 模板参考
  • API 参考
RainaDoc
  • RainaDoc Compile System Documentation
  • View page source

RainaDoc Compile System Documentation

RainaDoc 是 Raina EDA 工具链的文档自动生成系统。它从 XML 格式的命令定义文件中提取信息, 自动生成 Sphinx 可构建的 reStructuredText 文档,支持 HTML、PDF、singlehtml、man 等多种输出格式。

目录

  • 系统概述
    • 系统架构
    • 工作流程
    • 核心类关系
    • 为什么选择 reStructuredText
  • 使用方法
    • 命令行触发
    • 独立运行
    • 配置 XML 文件路径
    • PDF 文档生成流程
    • DOC 编译执行流程
    • 输出目录结构
    • 重复命令检测
  • XML 命令定义格式
    • 根元素:Module
    • 子元素:Command
    • 孙子元素:Option
    • 孙子元素:Group
    • 完整 XML 示例
  • RST 模板参考
    • 模板列表
    • 模板替换方式
  • API 参考
    • doc_generator.xml 模块
    • doc_generator.doc 模块
    • doc_generator.doc_template 模块
    • DocGenerator 入口
Next

© Copyright 2026, tanlinfeng.

Built with Sphinx using a theme provided by Read the Docs.