要启用SyntaxHighlight扩展,您需要按照以下步骤操作:
pip install pygments
pip install sphinxcontrib-serializinghtml
conf.py
)中添加如下代码:# 启用SyntaxHighlight扩展
extensions = [
'sphinxcontrib.contentui',
'sphinxcontrib.serializinghtml',
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.mathjax',
'sphinx.ext.doctest',
'sphinx.ext.ifconfig',
'sphinx.ext.githubpages',
'sphinx.ext.todo',
'sphinx.ext.extlinks',
'sphinx.ext.inheritance_diagram',
'sphinx.ext.graphviz',
'sphinxcontrib.spelling',
'sphinxcontrib.syntaxhighlight',
]
.. code-block::
指令并指定语言参数,例如:.. code-block:: python
def hello_world():
print("Hello, World!")
这将使得代码块以Python语法高亮显示。
sphinx-build -b html sourcedir builddir
这样,您就可以在生成的HTML文档中看到代码块以高亮的形式显示了。
希望以上解决方法能够帮助到您!