sphinx 使用CSS自定义字体颜色等

备注: 关于如何在Rst文件中自定义字体, 颜色, 请参考#2

  1. 创建我们自定义的.css文件, 比如叫 custom-style.css.
  2. .css中的class.. role::标记关联, 并将这些关联放到一个.rst文件中, 比如叫custom-sytle.rst.
  3. 告诉sphinx doc, 这两个文件在哪. 并且让sphinx doc自动为我们的所有rst文件include这个 custom-style.rst文件.

1. 创建我们自定义的custom-style.css文件

例如, 我们需要为字体添加颜色.

.red {
    color:red;
}
.blue {
    color:blue;
}
.green {
    color:green;
}

2. 在custom-style.rst文件中为各种风格定义一个role

.. role:: red

.. role:: blue

.. role:: green

(PS:此处文件名相对于原教程有修改)

3. 告诉Sphinx Doc

custom-style.css放到_static/custom-style.css处, 并在conf.py文件中加入:

def setup(app):
    app.add_stylesheet('custom-style.css')

(PS:此处路径相对于原教程有修改)

custom-style.rstcustom-style.css文件放在一起,并在conf.py文件中加入:

rst_epilog = '\n.. include:: /_static/custom-style.rst\n'

(PS:此处路径相对于原教程有修改;如果执行make html的时候提示找不到路径,就先执行一次make clean html就好了)

然后你就可以在你的文档中需要颜色的地方使用风格了:

- This is :red:`Red` text.
- This is :blue:`Blue` text.
- This is :green:`Green` text.

本帖对于原教程有修改的地方;原作者遇到的点开头文件名的问题我并未遇到

参考资料

https://github.com/MacHu-GWU/Tech-Blog/issues/3

You may also like...

发表评论

电子邮件地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据