f5网络的sphinx主题

f5-sphinx-theme的Python项目详细描述


https://travis-ci.org/f5devcentral/f5-sphinx-theme.svg?branch=master

f5 sphinx主题为使用Sphinx构建的项目提供f5网络样式和布局。对于任何未将文档发布到clouddocs.f5.com的项目,不应未经修改就使用此主题。

设置和配置

  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。

注意

根据发布/部署过程的不同,您可能需要重新构建文档以使更改生效。

版本选择器

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

/screenshots/version.png

默认情况下,版本选择器为未启用。 要启用它,请将以下设置添加到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。

许可证

apache v2.0

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

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

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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java为什么需要ScheduledExecutorService。shutdown()使用我100%的CPU吗?   java如何加载应用程序。spring框架中的属性?   java立即绘制JFrame   java定时器不允许用户进行编辑   java如何通过在React应用程序中提交值来加载数据   java在Multimultiul maven项目中集成特性(文件)存储在哪里?   java Arjuna JTA事务意外回滚   java禁用edittext 安卓,在视图中使用if-else   java中的错误。图书馆从Matlab调用使用Cplex的Java函数时的路径   Java中的浮点计算错误   Java中C#IEnumerable的等价物是什么?是可协变的,不是可协变的   最终播放商店用户可见的java Apk名称