跳转到主要内容

一个用于Sphinx的科学解释和文档的整洁主题

项目描述

quantecon-book-theme

QuantEcon书籍风格项目的Jupyter Book主题

用法

要在Jupyter Book中使用此主题

  1. 安装主题

pip install git+https://github.com/QuantEcon/quantecon-book-theme.git

  1. 将主题添加到您的_config.yml文件中
sphinx:
    config:
        html_theme: quantecon_book_theme

更新测试固定值

在布局更改时更新测试回归文件

建议在相关的布局文件更改时更新测试文件,以进行文件回归检查。

例如,目前我们有一个侧边栏文件回归检查,以验证测试中的html。它与之比较的文件是tests/test_build/test_build_book.html

如果更新侧边栏html,则更新此测试文件的一个简单步骤是

  1. 删除文件tests/test_build/test_build_book.html
  2. 在命令行中运行pytest,它将生成一个新的文件。检查该文件是否符合您的预期,是否包含您添加/修改的元素。

现在未来pytests将对这个文件进行测试,后续的测试应该会通过。

贡献指南

本仓库贡献指南的文档:https://github.com/QuantEcon/quantecon-book-theme/blob/master/docs/contributing/index.md

项目详情


下载文件

下载适用于您平台的文件。如果您不确定该选择哪个,请了解有关安装包的更多信息。

源代码分发

quantecon_book_theme-0.7.2.tar.gz (2.3 MB 查看哈希)

上传时间: 源代码

构建分发

quantecon_book_theme-0.7.2-py3-none-any.whl (207.2 kB 查看哈希)

上传时间: Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面