如何贡献文档

相关内容请参考https://rflybuaa.github.io/RflySimRTDoc/help/readme/

如何生成PDF

相关内容请参考https://pypi.org/project/mkdocs-with-pdf/

Tip

使用mkdocs-with-pdf插件需要提前安装weasyprint。在安装weasyprint之前,需要先安装GTK3.x。在安装GTK3.x时,推荐使用默认的安装选项,安装完成后重启(使环境变量生效)。
安装weasyprint: python -m pip install weasyprint

启用pdf生成,修改mkdocs.yml

plugins:
  - search
  - autorefs
  # - git-latest-changes #展示最近一次更新的变化
  # - git-latest-release
  - mkdocs-video:
      is_video: true
      video_autoplay: false
  - resize-images:
      source-dir: img-large
      target-dir: img
      enable_cache: True
      size: [400, 400]
      extensions: ['.jpg', '.jpeg', '.png', '.svg']
  - with-pdf:
        verbose: true

然后执行命令mkdocs build,随后将在site/pdf文件夹中生成PDF文件。

Tip

建议在生成pdf后,取消改插件设置。