为什么我的 sphinx-apidoc --templatedir 选项没有按预期工作？

Question

我正在尝试自定义

./docs/conf.py

以使文档管理更容易，所以我执行了以下命令：

sphinx-apidoc -F -o "./docs" --templatedir=./templates "."

我将以下

conf.py_t

文件放在

./templates

目录中，但

--templatedir

选项似乎没有按预期工作。 （我检查了生成的

./docs/conf.py

文件，和

./templates/conf.py_t

中的模板文件不一样。当然，我每次执行这个命令之前都会删除

./docs

目录）。

您能帮我了解如何解决这个问题吗？ 谢谢您的合作。

这是问题的详细信息。 谢谢您的协助。

• 操作系统：Windows

• Shell：PowerShell

• Python环境:

  • 迷你康达：24.1.2
  • Python：3.12.2

• Sphinx 版本：8.1.3

• 执行结果

ファイル C:\Users\username\Downloads\test\docs\conf.py を作成しています。
ファイル C:\Users\username\Downloads\test\docs\index.rst を作成しています。
ファイル C:\Users\username\Downloads\test\docs\Makefile を作成しています。
ファイル C:\Users\username\Downloads\test\docs\make.bat を作成しています。

这就是说，每个文件生成时都没有错误消息。 （语言设置为日语）

---

conf.py_t

文件内容

#hogehoge
#hogehoge
#hogehoge
#hogehoge
#hogehoge
#hogehoge
#hogehoge
# Configuration file for the Sphinx documentation builder.
# 
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os
import sys
sys.path.insert(0, os.path.abspath('../'))

# -- Project information -----------------------------------------------------

project = '{{ project_name }}'
copyright = '{{ copyright_year }}, {{ author }}'
author = '{{ author }}'

# The full version, including alpha/beta/rc tags
release = '{{ version }}'

# -- General configuration ---------------------------------------------------

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode'
]

templates_path = ['_templates']
exclude_patterns = []

# -- Options for HTML output -------------------------------------------------

html_theme = 'alabaster'
html_static_path = ['_static']

---

生成

./docs/conf.py

文件内容

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'test'
copyright = '2024, Author'
author = 'Author'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.viewcode',
    'sphinx.ext.todo',
]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

language = 'en'

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']

# -- Options for todo extension ----------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration

todo_include_todos = True

注意：生成的

conf.py

文件与

conf.py_t

模板文件不同，不知道为什么模板没有被应用。

注意：我创建了一个 GitHub 存储库，可以在其中重现该问题。有需要的请随时看一下

https://github.com/wassawa1/sphinx-template-diff-test/actions

Answer 1

上面两位的评论已经解决了这个问题。谢谢回复的人。