From 3a4652fa816d8487bf9e41cb0d3d23adc83c27da Mon Sep 17 00:00:00 2001 From: caishilong <1103837067@qq.com> Date: Sun, 20 Oct 2024 18:16:21 +0800 Subject: [PATCH] =?UTF-8?q?docs=20=E4=BB=A3=E7=A0=81=E9=AB=98=E4=BA=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/conf.py | 40 +++++++++++++++++++++++++++++++++++----- 1 file changed, 35 insertions(+), 5 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d54a595..bbfa2ff 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -38,6 +38,15 @@ project = 'HA4T' copyright = '2024, caishilong' author = 'caishilong' +version = u'' # 主要版本号 +release = u'' # 完整版本号 + +# 代码高亮 +pygments_style = 'sphinx' + +# 显示 todo 列表 +todo_include_todos = True + # 语言设置 language = 'zh_CN' @@ -55,10 +64,31 @@ # locale_dirs = ['locale/'] # gettext_compact = False +# Read the Docs 主题配置 html_context = { - "display_github": True, # 显示 GitHub 链接 - "github_user": "Exuils", # 你的 GitHub 用户名 - "github_repo": "HA4T", # 你的 GitHub 仓库名 - "github_version": "main", # 分支名,通常是 main 或 master - "conf_py_path": "/docs/source/", # conf.py 文件所在的路径 + "display_github": True, + "github_user": "Exuils", + "github_repo": "HA4T", + "github_version": "main", + "conf_py_path": "/docs/source/", + "current_language": "zh_CN", + "current_version": version, } + +latex_documents = [ + (master_doc, 'HA4T.tex', u'HA4T Documentation', + u'caishilong', 'manual'), +] + +# 手册页输出配置 +man_pages = [ + (master_doc, 'ha4t', u'HA4T Documentation', + [author], 1) +] + +# Texinfo 输出配置 +texinfo_documents = [ + (master_doc, 'HA4T', u'HA4T Documentation', + author, 'HA4T', 'One line description of project.', + 'Miscellaneous'), +]