ADCtheme 技术文档

1. 安装指南

1.1 在 Sphinx 中安装

将本目录复制到 Sphinx 安装的 sphinx/themes 目录下。例如，在 Mac OS X 系统上的标准安装路径是 /Library/Python/2.6/site-packages/。

1.2 在其他位置安装

如果您想将主题安装在其他位置，需要修改 conf.py 文件：

templates_path = ['/absolute/path/to/dir/','relative/path/']

1.3 直接在您的文档中包含

如果您想直接在文档中包含文件，以便其他人可以构建您的文档，操作非常简单。

1. 将 static 目录中的所有内容复制到文档源文件夹的 _static 目录中。
2. 将 layout.html 文件复制到文档源文件夹的 _templates 目录中。
3. 修改您的 conf.py 文件：

html_theme = 'basic'
html_style = 'adctheme.css'

代替原来的 'ADCtheme'。

2. 项目使用说明

为了让 Sphinx 使用该主题，请按照以下步骤操作：

• 如果没有直接将文件安装到文档中，请编辑 conf.py 文件并设置以下选项：

html_theme = 'ADCtheme'

3. 项目API使用文档

本项目主要是作为 Sphinx 文档的一个主题使用，因此没有特定的 API。不过，您可以通过修改 conf.py 文件以及相应的模板文件来自定义主题的行为和外观。

4. 项目安装方式

请参考上述“安装指南”部分，根据您的具体需求选择合适的安装方式。无论是将主题文件夹复制到 Sphinx 的主题目录中，还是在其他位置安装，或者直接在您的文档中包含主题文件，都需要对 conf.py 文件进行相应的配置修改。