WebSupport 类¶
- class sphinxcontrib.websupport.WebSupport¶
Web support 包的主要 API 类。所有与 Web support 包的交互都应通过此类的实例进行。
该类接受以下关键字参数
- srcdir
包含 reStructuredText 源文件的目录。
- builddir
构建数据和静态文件应放置的目录。在使用将用于构建数据的
WebSupport对象时应使用此参数。- datadir
Web support 数据所在的目录。在使用将用于检索数据的
WebSupport对象时应使用此参数。- search
这可以包含一个字符串（例如 'xapian'），引用一个内置的搜索适配器，或一个
BaseSearch子类的实例。- storage
这可以包含一个表示数据库 URI 的字符串，或一个
StorageBackend子类的实例。如果未提供，将创建一个新的 sqlite 数据库。- moderation_callback
当添加了未显示的评论时要调用的可调用对象。它必须接受一个参数：一个表示已添加评论的字典。
- staticdir
如果静态文件应该在不同位置创建，**而不是在**
'/static'中，这应该是一个包含该位置名称的字符串（例如builddir + '/static_files'）。注意
如果您指定了
staticdir，您通常会希望相应地调整staticroot。- staticroot
如果静态文件不是从
'/static'提供服务，这应该是一个包含该位置名称的字符串（例如'/static_files'）。- docroot
如果文档不是从 URL 的基本路径提供服务，这应该是一个指定该路径的字符串（例如
'docs'）。
1.6 版本更改: WebSupport 类已从 sphinx.websupport 移动到 sphinxcontrib.websupport。请在您的依赖项中添加 sphinxcontrib-websupport 包，并使用移动后的类。