Web Support类

class sphinxcontrib.websupport.WebSupport

Web支持包的主要API类. 与Web支持包的所有交互都应该通过此类进行.

该类采用以下关键字参数:

srcdir

包含reStructuredText源文件的目录.

builddir

应该放置构建数据和静态文件的目录. 这应该在创建 WebSupport 对象时使用, 该对象将用于构建数据.

datadir

Web支持数据所在的目录. 在创建将用于检索数据的 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 包, 然后使用移动的类.

方法