WebSupport 类¶
- class sphinxcontrib.websupport.WebSupport¶
web支持包的主要API类.所有与web支持包的交互都应该通过这个类进行.
该类接受以下关键字参数:
- srcdir
包含 reStructuredText 源文件的目录.
- 构建目录
构建数据和静态文件应放置的目录.当创建将用于构建数据的
WebSupport对象时,应使用此目录.- datadir
Web 支持数据所在的目录.在创建一个将用于检索数据的
WebSupport对象时应使用此目录.- 搜索
这可能包含一个字符串（例如 ‘xapian’）,引用要使用的内置搜索适配器,或者是
BaseSearch子类的一个实例.- 存储
这可以是表示数据库 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 包,并使用已移动的类.