edx-sphinx-theme 1.5.0

概述

此主题对默认sphinx输出进行以下更改：

• 显示EDX徽标
• 添加指向反馈表单的链接，该表单标识反馈来自哪个页面

将edx sphinx主题用于存储库的文档：

• pip install edx-sphinx-theme或等效值（添加edx-sphinx-theme 任何适当的需求文件）
• 将edx_theme添加到conf.py中的extensions列表中（它将 每个页面的呈现上下文的反馈表单url）。
• 更新conf.py中的html_theme和html_theme_path值，以便 可以定位和加载主题。
• 将html_favicon设置为主题中favicon.ico文件的路径。
• 在conf.py中适当的地方使用AUTHOR常量 （此默认设置只是为了方便起见；存储库是免费的 在适当的情况下使用另一个值）。

例如：

importosimportedx_themeextensions=['edx_theme']copyright='{year}, edX Inc.'.format(year=datetime.datetime.now().year)author=edx_theme.AUTHORhtml_theme='edx_theme'html_theme_path=[edx_theme.get_html_theme_path()]html_favicon=os.path.join(html_theme_path[0],'edx_theme','static','css','favicon.ico')latex_documents=[(master_doc,'edx-sphinx-theme.tex','edx-sphinx-theme Documentation',author,'manual'),]

阅读文档配置

因为这个主题是一个需要安装的python包，Read the Docs需要进行适当的配置，以便能够在 执行文档生成。在Advanced Settings：

• Install your project inside a virtualenv using setup.py install应该 检查
• Requirements file应该指向一个pip需求文件，该文件包括 open-edx-theme。

文档

完整的文档位于https://edx-sphinx-theme.readthedocs.org。

许可证

此存储库中的代码是根据apache软件许可证2.0授权的，除非 另有说明。

有关详细信息，请参见LICENSE.txt。

如何贡献

我们非常欢迎您的贡献。

请阅读How To Contribute了解详细信息。

尽管它们是在考虑edx-platform的情况下编写的，但是 对于打开的edx代码，通常应遵循。

报告安全问题

请不要公开报告安全问题。请发电子邮件给security@edx.org。

获取帮助

有关于这个存储库的问题，或者关于open edx的一般问题吗？拜托 如果您需要帮助，请参考本list of resources。

更改日志