f5-sphinx-theme 2.0.2

设置和配置

1. pip install f5-sphinx-theme

2. 使用以下设置更新项目的conf.py：

   import f5_sphinx_theme
   html_theme = 'f5_sphinx_theme'
   html_sidebars = {'**': ['searchbox.html', 'localtoc.html', 'globaltoc.html']}
   

3. （可选）设置html_theme_options{}字典。支持的选项如下所示。

   html_theme_options = {
                           'site_name': '<desired site name>',          \\ DEFAULTS TO "CloudDocs home"
                           'next_prev_link': True or False              \\ DEFAULTS TO FALSE
                           'html_last_updated_fmt': '%Y-%m-%d %H:%M:%S' \\ REQUIRED FOR FEDERATED SEARCH, DO NOT CHANGE
                           # 'base_url' = ''                            \\ DEFAULTS TO '/'
                        }
   

   base_urltheme选项旨在允许自定义根url。

版本选择器

您可以将版本选择器添加到导航栏，如下所示：

默认情况下，版本选择器为未启用。 要启用它，请将以下设置添加到docs/conf.py:

html_theme_options={'version_selector':True,}html_context={'version_meta_path':'uri/of/your/json/versions/file.json','project_safe':re.sub('[^A-Za-z0-9]+','',project)}

'version_meta_path'指的是version.json文件在主机s3存储桶中的位置。 版本选择器中显示的版本是通过ajax调用从这个json文件生成的。您只需更新一个文件即可在所有版本中进行更改。 生成json由实现者（即您）决定，但它可以合并到ci/cd进程中。 理想情况下，json应该位于s3中项目目录的根目录中，版本位于子文件夹中，如下所示：

project_root
  |
  +---versions.json
  |
  +---v2.0.0
  |   \--- <docs_html>
  |
  +---v1.0.1
  |   \--- <docs_html>
  |
  +---v1.0.0
      \--- <docs_html>

有关基本示例，请参见此repo中的[test]（/test）目录。

用法

有关详细信息，请参见project wiki。

测试

此项目使用travis ci作为ci/cd。

版权所有

版权所有2017-18 F5 Networks Inc.

许可证

apache v2.0

根据apache许可证2.0版（以下简称“许可证”）授权；您可以 除非符合许可证，否则不要使用此文件。你可以获得 在

http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则软件 根据许可证分发是按“原样”分发的， 无任何明示或默示的保证或条件。 有关管理权限的特定语言和 许可下的限制。