如何配置斯芬克斯扩展



在关于sphinx扩展的文档中;config值";。例如,在sphinx.ext.autodoc.中

但我不知道如何设置这些值。这是我必须设置的外壳上的一个参数吗?

文档中有一个页面教您如何使用扩展。页面在这里:https://www.sphinx-doc.org/en/master/usage/extensions/index.html

在此页面中,您有以下描述:

作为扩展模块名称的字符串列表。这些可以是Sphinx附带的扩展(名为Sphinx.ext.*(,也可以是自定义扩展。

这告诉你sphinx.ext.*是内置的扩展(你可以从这里确认(

基本上,当它声明某种配置时,它指的是运行sphinx-quickstart时生成的conf.py文件,这是sphinx的一个快速设置命令(读起来可能很好:https://www.sphinx-doc.org/en/master/usage/quickstart.html)

Sphinx纯文本文档源集合的根目录称为源目录。该目录还包含Sphinx配置文件conf.py,您可以在其中配置Sphinx读取源代码和构建文档的所有方面。

Sphinx附带了一个名为Sphinx quickstart的脚本,该脚本设置了一个源目录,并创建了一个默认的conf.py,其中包含它向您提出的几个问题中最有用的配置值。

请注意,由于它是内置的,因此它已经与您的斯芬克斯项目一起安装好了。但如果你想以某种方式自定义它,你可以使用带有autodoc_*配置的conf.py文件(如这里所列(

还有一些注释可能对您的案例有用

对于Sphinx(实际上是执行Sphinx的Python解释器(,要找到您的模块,它必须是可导入的。这意味着模块或包必须位于sys.path上的某个目录中——相应地调整配置文件中的sys.path。

相关内容

  • 没有找到相关文章

最新更新