无法让本地 sphinx-apidoc 模板工作

Question

回复：使用

sphinx-apidoc

通过

autodoc

扩展从文档字符串自动生成 API 参考...

我将全局

/site-packages/sphinx/templates/apidoc/package.rst_t

模板复制到本地文件夹，并进行了无意义的编辑。当我构建 API 文档时，无意义的编辑是不可见的，即。本地模板似乎没有覆盖全局模板。

这是我本地的

docs/source

目录：

|_ docs
   |_ source
      |_ templates
      |    package.rst_t
      |_ conf.py
      |_ index.rst

conf.py

包含此指令：

templates_path = ['templates']

我使用此命令构建了 API 文档：

sphinx-apidoc -e -M -f --templatedir=./templates -o ./source/autodoc ../myproject

有人能看出出了什么问题吗？

Answer 1

我可以看到你回答了你自己的问题，但我仍然会提出我遇到的问题类型和解决方案，以防其他人需要，因为这个问题的标题很方便。

这是我本地

docs

目录的树：

docs
├── Makefile
├── build
├── make.bat
└── source
    ├── _static
    ├── _templates
    │   ├── module.rst_t
    │   ├── package.rst_t
    │   └── toc.rst_t
    ├── conf.py
    └── index.rst

致电

sphinx-apidoc

：

sphinx-apidoc -o source/$(PROJECTNAME) --templatedir=source/_templates ../src/$(PROJECTNAME)

其中

PROJECTNAME

是带有项目名称的环境变量。

我今天重新生成了我们的文档，并意识到根本没有考虑到模板。这是因为模板文件的扩展名应从

rst_t

更改为

rst.jinja

。

这是从最新版本：7.4.0（实际上是从今天开始）以来的情况，您可以在这里查看相应的拉取请求和说明。

因此，要使其再次工作，我所要做的就是更改扩展名，现在目录树

docs/source

看起来像这样：

source
├── _static
├── _templates
│   ├── module.rst.jinja
│   ├── package.rst.jinja
│   └── toc.rst.jinja
├── conf.py
└── index.rst

一切都运转正常。 希望这有帮助。