Changelog

下一版本(正在开发中)

0.7.16 --2024-01-10

  • #215 不显示 logo_name 如果将其设置为 False 。

0.7.15 --2024-01-08

  • #213 属性中允许使用任意字符串 logo_name 选择。

  • #114 改进了侧边栏的CSS样式。

  • #178 已弃用 canonical_url 赞成 html_baseurl 。

  • #200 删除重复项 <meta name="viewport" ... /> 标签。

  • #188 删除了空格中的下划线。

  • #164 已删除 type="text/javascript" 来自<脚本>元素。

  • #161 取代 &copy; 具有Unicode十进制代码实体 #169; 。

0.7.14 --2024-01-08

  • 不再支持Python3.8及更早版本。

  • 不再支持Sphinx 3.3及更早版本。

  • #198 修正了手机上水平滚动的问题。

  • #206 适当地支持 html_support_sphinx 配置值。

  • #211 修好GitHub‘ForkMe’的横幅。

  • 增列 alabaster_version_info 添加到HTML模板上下文中。

  • 声明支持Python3.13。

  • 采用了拉夫衬垫和格式化程序。

  • 从CircleCI迁移到GitHub操作。

0.7.13 --2023-01-13

  • 现代化项目：S/特拉维斯/圈/CI，自述徽章， setup.cfg 删除、元数据刷新等。

  • 不再支持Python2和Python3.6以下版本。这包括各种较小的更新，以便与Sphinx的现代版本(最低版本为1.6)一起正常工作。感谢亚当·特纳在这里打了一堆补丁。

    警告

    如果您使用的是旧的Python版本，则此更改向后不兼容。

  • 稍微调整了一下CSS，使其与现代Sphinx版本的基本样式表兼容。

0.7.12 --2018/10/02

  • 在一些浏览器/平台上，‘徽章’风格的侧边栏元素显示虚线。这是无意的，添加了显式样式以删除它们。这是史蒂文·洛里亚的功劳。

  • 重新组织 customization page 将现在相当长的“变量和特性切换”列表分成多个部分；包括按字母顺序排列这些列表，以便更容易地找到特定设置的文档。

  • #132 (部分通过 #143 )添加通用捐赠徽章/URL选项(视觉上由https://shields.io/)提供支持，并为 OpenCollective 。

    我们希望稍后会有更多针对Patreon等服务的特定服务选项。感谢Melanie Crutchfield的报告和Steven Loria的最初补丁。

  • #128 将GitTip/Gatipay输出从 donate.html 边栏组件，因为实际服务自2017年以来已资不抵债。配置选项暂时保持不变(以避免破坏向后兼容性)，但不再执行任何操作。感谢Joe Alcon提供的报告/原始补丁集。

    备注

    有关的信息，请参阅ChangeLog条目 #132 ，它重新引入了一个更通用的捐赠侧边栏框架。

  • #142 添加 tidelift_url 选项，该选项在设置时(默认为 None /unset)将一个小文本片段添加到 donate.html 侧边栏组件，链接到给定的URL字符串。感谢史蒂文·洛里亚的补丁。

  • #141 修复代码中的一个拼写错误-挡路字体系列，指定错误 Deja Vu Sans Mono 而不是 DejaVu Sans Mono 。这将主要影响缺少前两种字体的系统 (Consolas 和 Menlo )，例如Linux台式机。感谢伊利亚·特鲁克汉诺夫的接球与补丁。

0.7.11 --2018-06-18

  • #73 清理一些有问题的字体问题：

    • 删除完全损坏的Goudy Old样式，以及其他大多数仅支持Adobe的字体 font_family 配置设置；现在只需 Georgia, serif 这是大多数用户无论如何都在渲染的。

    • 清除的默认值为 head_font_family (其中包含 Garamond ，这是一种不错但也是Adobe Only的字体)

    • 集合 head_font_family 所以它会回落到 font_family 除非用户自己明确地设置了它。

    备注

    你总是可以通过以下方式回到旧的价值观 explicitly setting font_family 和/或 head_font_family 在你的 conf.py %s html_theme_options ，例如：

    html_theme_options = {
    'description': 'My awesome project',
    'font_family': "goudy old style, minion pro, bell mt, Georgia, Hiragino Mincho Pro, serif",
}

    警告

    根据个人观众系统的不同，此更改 may 是 视觉上 如果您尚未覆盖字体设置，并且这些用户具有有问题的字体(在大多数系统上不是默认字体)，则向后不兼容。

    如上面的注释所示，您可以 总是 使用您的配置文件覆盖新默认值以返回到旧行为。

  • #18 (通过 #101 )添加可选 next 和 previous 页面内容顶部和底部的链接。使用主题选项 show_relbars 以实现这些功能。来源：威廉·明钦。

  • 其他项目维护更新，如添加到Travis CI和强制使用 flake8 。

  • #110 增列 badge_branch 选项允许配置Travis、Codecov等按钮默认的特定Git分支。积分： @TitanSnow 。

  • #111 添加setupTools级别的入口点，以改进主题分发兼容性。感谢亚伦·卡莱尔的补丁。

0.7.10 --2017/02/28

  • #32 更新告诫等各种挡路级别元素的样式 (.. note:: ， .. warning:: 等)和代码块 (.. code:: )，因此它们不再“凹陷”在它们嵌入的主文本列之外。这既是风格上的改变，也是错误修复，因为例如嵌套代码块 在内部 注解块看起来是主动损坏的。感谢清川隆之的报道。

  • #96 admonition_xref 有一个模板排版错误，使其无法接收样式；此问题已修复。致谢：Kenzie Togami。

  • #95 独立地穿过 sphinx-doc/sphinx#3276 也就是说，如果在Sphinx 1.4.x上运行，参数列表会被挤在一起。虽然该修复已合并到Sphinx本身中，但我们认为谨慎的做法是将其也包含在我们自己的样式表中，以便立即得到缓解。

0.7.9 --2016/07/25

  • #6 （和 #70 ，两者均通过 #84 )使所有剩余的硬编码样式颜色都是可配置的，并进行相关的清理(例如改善某些警告块的区别，例如 warn 和 note ，确保一般警告保持不变，等等)。积分： @ShadowKyogre .

  • #83 暴露Sphinx的毒瘤树 collapse 选项作为新选项 sidebar_collapse 配置选项。字幕：埃里克·霍尔舍尔。

  • #80 增加支持 <link rel="canonical"> (即规范URL)。感谢本·伽马利的贴片。

  • #7 生成真正的文档站点，两者都是因为自述文件现在太大了，所以我们可以 eat our own dog food 。

0.7.8 --2016-05-05

  • #51(通过#67)：在以下情况下隐藏Github按钮 github_user 和 github_repo 都没有设置好。这是必要的，因为 github_button 默认为True。感谢萨姆·怀特的报道和德米特里·沙赫涅夫的补丁。

  • #75：使用Travis-CI按钮的SVG版本。感谢塞巴斯蒂安·维斯纳的补丁。

  • #41：更新Github按钮以使用较新的链接图像，并更改指向其文档的链接。多亏了托米·胡卡莱宁。

  • #45(通过#46)调整嵌套项目符号列表的样式，以防止在较小的显示尺寸上查看时它们都折叠到相同缩进级别的问题。感谢Bram Geron的Catch&Patch，感谢Jochen Kupperschmidt的评论/讨论。

  • #44(部分；通过#57)为喜欢不会滚动出视图的侧边栏的用户添加一个选择加入的固定侧边栏行为。字幕：乔·克罗斯。

  • #61：设置小但非零的脚注宽度以解决常见的浏览器显示错误。感谢康斯坦丁·莫尔查诺夫的“捕捉与修补”。

  • #64：添加字体大小和标题字体大小/系列的配置选项。来源：马萨尔·索拉(Marçal Solà)。

  • #78：添加自定义样式表支持。(因此，这个版本将是最后一个合并简单的样式调整作为功能切换的版本-只有棘手的CSS问题或与模板相关的实际更改将在之后合并。)

  • #65：将侧边栏的“导航”头包装在Sphinx的翻译助手中，以便在可能的情况下进行翻译。感谢 @uralbash .

  • #77：修复图像链接样式以删除在某些情况下出现的底部边框。感谢埃里克·霍尔舍尔的补丁& @barbara-sfx 为了这份报告。

0.7.7 --2015/12/21

  • 加一些 margin-bottom 到 table.field-list p 因此，字段列表(例如，文档字符串中的Python函数参数列表)写成多个段落时，看起来就像实际的段落，而不是全部组合在一起。

  • 修复自述文件中的错误注释重新命名：已重命名 github_button_* 选项-- button_ 被丢弃了，但医生没有反映这一点。多亏了尼克·尼比。

  • 固定 sidebar_hr Setting-StyleSheet没有正确引用正确的变量名。多亏了詹尼斯·莱德尔。

  • 允许配置正文文本-通过对齐 body_text_align 。这归功于马萨尔·索拉(Marçal Solà)。

  • 修复模板中少数不匹配/未关闭的HTML标记。感谢马文·平托的“接球与补丁”。

  • 增列 Codecov 对侧边栏的徽章支持。

0.7.6 --2015-06-22

  • 更新方式 setup.py 处理 README.rst file-将其显式加载为UTF-8，以便不会生成包含非ASCII字符的ChangeLog UnicodeDecodeError 在其默认编码不是UTF-8或其他Unicode兼容编码的终端环境中。感谢阿伦·佩尔绍德的报告和马克斯·特普基夫提出的修复建议。

  • 修复列表项元素中代码块的左边距和填充样式，使其与应用于顶级代码块的早期更改保持一致。

  • 将页面边栏宽度显示为主题选项(&S) page_width 和 sidebar_width 。它们的默认值与之前的静电值相同。

0.7.5 --2015-06-15

  • 尊重Sphinx的核心 html_show_copyright 选项来呈现页脚。感谢马辛·沃伊迪尔的报道。

  • 史前版本的Alabaster试图删除“相关”子导航(通常在其他主题中作为下一个/上一个链接)，但这对面向移动的样式不起作用。

    通过(重新)为这些链接添加改进的侧栏导航元素，并使其显示可通过新的 show_related 主题选项(默认为 false 用于向后兼容)。

    备注

    To enable the related-links nav, you'll need to set show_related to true and add relations.html to your html_sidebars (we've updated the example config in this README to indicate this for new installs).

    感谢Tomi Pieviläinen的错误报告。

  • 更新“Fork Me on Github”横幅图像以使用 https:// URI以便通过HTTPS托管的网站不会遇到混合内容错误。感谢 @nikolas 对于补丁。

  • 删除孤立的 </li> 从页脚“show source”部分。这是马辛·沃伊迪尔的功劳。

0.7.4 --2015-05-03

  • 添加 code_highlight 选项(包括对包含突出显示行的代码块样式的常规修复)。多亏了史蒂文·洛丽亚。

0.7.3 --2015-03-20

  • 隐藏 shadow 书目元素的相关样式，除了以前的更改Re： border 。再次感谢菲利普·德苏。

0.7.2 --2015-03-10

  • 更新了CSS样式表，以将等宽样式应用于这两个样式 tt 和 code 元素，而不仅仅是 tt 。这解决了Sphinx1.3中HTML生成的变化，同时保留了对Sphinx1.2的支持。感谢埃里克·霍尔舍尔的提醒。

0.7.1 --2015-02-27

  • 最后，添加ChangeLog。到自述文件中去，目前，因为一个完整的文档站点还不值得。

  • 允许配置自定义Github横幅图像(而不是简单地打开或关闭默认设置)。感谢Nicola Iarocci的原始补丁。

  • 明确说明自述文件中的Python版本支持和 setup.py .

  • 更新Github按钮图像链接以使用最新可用的HTTPS版本的URL；这有助于防止通过HTTPS提供的文档页面出现错误。感谢古斯塔沃·纳里亚的报道。

  • 添加对代码块的字体大小和系列的控制。这是史蒂文·洛里亚的功劳。

  • 允许控制正文文本和标题的字体系列。多亏了格奥尔格·布兰德尔。

  • 样式化 .. seealso:: 数据块与 .. note:: 块以保持一致性(以前， .. seealso:: 使用Sphinx默认样式，这会发生冲突)。我们稍后可能会再次更新这些内容，但现在，这是一个改进！再次感谢史蒂文·洛里亚。

  • 允许控制CSS font-style 用于站点描述/标语行元素。字幕：史蒂文·洛丽亚(Steven Loria)。

  • 添加样式以禁用默认单元格边框 .. bibliography:: 指令的输出。感谢菲利普·德苏的报告。

0.6.2 --2014/11/25

  • 制作 .. warn:: 方块有粉红色的背景(而不是没有背景，这显然是忽略了Alabaster所基于的主题)，并且使该颜色可配置。

0.6.1 --2014-09-04

  • 更新GitTip支持以确认该服务已重命名为Gatipay。

0.6.0 --2014-04-17

  • 允许隐藏页脚的“Powered By”部分。

  • 修复中的过时名称 setup.py URL字段。

0.5.1 --2014-04-15

  • 修复新的Travis支持中的错误，Re：其默认值。

0.5.0 --2014-04-09

  • 添加对侧栏Travis状态按钮的支持。

0.4.1 --2014-04-06

  • 修正描述中的不准确之处 logo_text_align .

  • 更新徽标和文本样式，使其更加合理。

0.4.0 --2014-04-06

  • 添加一个选项以允许取消隐藏一个人的toctree。

0.3.1 --2014-03-13

  • 改进了Python 3兼容性。

  • 更新由生成的ChangeLog页面的样式 bitprophet/releases .

0.3.0 --2014-02-03

  • 在Sphinx版本(需要使用迷你Sphinx扩展)加上其他页脚调整的同时，在页脚显示Alabaster版本。

0.2.0 --2014-01-28

  • 允许控制徽标替换文本的对齐方式。

  • 添加自定义导航侧栏元素。

  • 稍微调整一下页边距。

  • 在样式表中添加第三级中灰色，并在几个地方应用。

0.1.0 --2013/12/31

  • 第一个标记/PyPI的版本。