editorial-sphinx-theme 1.0.1

VIA套餐

下载包或将其添加到requirements.txt文件：

$ pip install editorial_sphinx_theme

在conf.py文件中：

importeditorial_sphinx_themehtml_theme="editorial_sphinx_theme"html_theme_path=[editorial_sphinx_theme.get_html_theme_path()]

通过git或下载

您可以直接从git存储库中安装它，记住这将下载最后所做的更改 可能不稳定，导致失败。对于生产中的站点，请尝试使用pypi中提供的版本。

有两个主要分支“主”与稳定的代码和“开发”与最新的修改。

symlink或subtree将editive_sphinx_theme/editive_sphinx_theme存储库链接到您的文档中 docs/\u themes/editorial\u sphinx\u theme然后将以下两个设置添加到sphinx conf.py文件：

分支master

pip install -e git+https://gitlab.com/opb/editorial-sphinx-theme.git@master#egg=editorial_sphinx_theme

分行开发

pip install -e git+https://gitlab.com/opb/editorial-sphinx-theme.git@develop#egg=editorial_sphinx_theme

html_theme="editorial_sphinx_theme"html_theme_path=["_themes",]

基本

基本工具或功能

滚动到顶部

Include a button in the lower right corner to return to the top of the page.

prev_next_按钮u底部

Navigation buttons at the end of the page, to go to the previous and next page.

prev_next_按钮侧边栏

Navigation buttons at the end of the sidebar, to go to the previous and next page.

回购信息

与使用过的存储库相关的信息

回购名称

Name of the repository service, for example GitLab. This name will be displayed in some parts of the page.

repo网址

Repository address, for example: https://gitlab.com/opb/editorial-sphinx-theme

谷歌分析[可选]

分析ID

This indicates the Google Analytics ID used by this service, if you do not pass any value the javascript script will not load on the page. The value must have the format “UA-XXXXX-Y”.

异步分析

This option indicates which version of the Google Analytics script to use, for more information in your website https://developers.google.com/analytics/devguides/collection/analyticsjs/#alternative_async_tracking_snippet

社交链接[可选]

在标题中添加一系列指向不同社交网络的链接，它们不需要单独的解释。够了 指示激活社交网络的URL

提供：GitHub、BitBucket、GitLab、其他Git、Twitter、Facebook

Fork Me Ribbon[可选]

您可以在页面的一角启用功能区，并使用图例“fork me on<；repo_name>；”和 目标url是“repo_url”中指定的存储库

您可以使用的选项如下：

forkme_色带

It enables the use, only loaded if it is equal to ‘True’.

forkme_对齐

Where shown, take the following locations: left-top, right-top, left-bottom, right-bottom

forkme_已修复

If you pass ‘True’ to this option, the ribbon will be shown with the CSS property fixed, and as we scroll on the page will continue showing in the same corner.