首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Python Sphinx从conf.py内部访问html_context

Python Sphinx是一个用于文档生成的工具,它可以将标记语言编写的文档转换为各种格式,包括HTML、PDF、EPUB等。conf.py是Sphinx项目的配置文件,用于配置项目的各种参数和选项。

在conf.py内部访问html_context是指在该文件中访问和配置html_context变量。html_context是一个字典,用于向生成的HTML文档中添加自定义的上下文变量。这些变量可以在文档中使用,以便在生成过程中动态地插入内容。

通过在conf.py中访问和配置html_context,可以实现一些自定义的功能,例如添加全局的变量、配置全局的样式、引入外部资源等。具体来说,可以通过修改html_context字典的值来添加自定义的键值对,然后在文档中使用这些键值对。

以下是一个示例,展示如何在conf.py内部访问html_context并添加自定义变量:

代码语言:txt
复制
# conf.py

# 添加自定义变量到html_context
html_context = {
    'custom_variable': 'Custom Value',
}

# 其他配置项...

在上述示例中,我们向html_context字典中添加了一个名为'custom_variable'的自定义变量,并将其值设置为'Custom Value'。接下来,在生成的HTML文档中,可以通过使用该变量名来引用这个自定义变量。

需要注意的是,html_context只在生成HTML文档时起作用,对于其他格式的文档可能没有影响。

对于Python Sphinx的更多信息和详细配置,请参考腾讯云的产品文档:Python Sphinx产品介绍

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

ReStructuredText 文档编写全攻略编写文档说明

web.png 公司内部的项目文档也采用这种方式,近期有接触,把整体流程总结一下。...,依赖的工具有:sphinx sphinx 介绍 sphinx 是一个基于python的文档生成工具,许多 python 项目都用使用这个工具自动生成文档。...安装python 前提需要 python 环境 2. 安装sphinx pip install sphinx 3. 创建文档项目 sphinx_quickstart 几乎是一路默认下来。看操作提示。...之后文件目录结构如下: _build/ _static/ _templates/ conf.py* index.rst make.bat Makefile 其中: conf.py 是配置文件...没问题,问题出在两者采用了不同的主题,scrapy 文档的风格是: sphinx-rtd-theme pip install sphinx_rtd_theme 配置:conf.py 文件 import

5.7K31
  • sphinx入门指南【1】快速入门

    安装 使用pip进行安装: pip install sphinx 设置源文件目录 包含.rst文件的根目录称之为源文件目录,目录中还包含sphinx的配置文件conf.py。...进入源文件目录,执行以下命令,会指引用户配置整个项目: sphinx-quickstart 定义文件结构 执行上述命令之后,sphinx会在源文件目录中自动生成conf.py文件以及index.rst。...例如py:class以及py:method 基本配置 sphinx通过conf.py进行配置,conf.py使用python语法,默认以utf-8编码保存。...自动生成文档注释 sphinx支持python源代码中提取文档注释信息,然后生成文档,我们将这称之为autodoc。...首先安装主题库: pip install sphinx_rtd_theme 然后配置conf.py: import sphinx_rtd_theme html_theme = "sphinx_rtd_theme

    2.2K40

    使用 sphinx 制作简洁而又美观的文档

    于是粗率的学习了下sphinx ---- Sphinx 是用 Python 编写的,并且最初是为 Python 语言文档而创建,但它并不一定是以语言为中心,在某些情况下,甚至不是以程序员为中心。...要求 安装: pip install sphinx 语法 Sphinx 使用 reStructuredText 标记语法类似与Markdown 具体可查看: http://zh-sphinx-doc.readthedocs.org...#sphinx-apidoc 安装readthedocs主题 # pip install sphinx_rtd_theme 编辑conf.py import sphinx_rtd_theme...html时,会尝试将你的项目导入并运行,因此需要将你的项目添加至python的环境变量中 编辑conf.py sys.path.append(os.path.join([os.getcwd(),...编辑contrib.rst contrib.Domain module ------------------- .. automodule:: contrib.Domain contrib.Domain

    1.8K60

    Sphinx初尝

    新版的Python文档就是由Sphinx生成的, 并且它已成为Python项目首选的文档工具,同时它对 C/C++ 项目也有很好的支持; 并计划对其它开发语言添加特殊支持....此为最新的Python文档 https://docs.python.org/zh-cn/3/ 首先创建一个文件夹,为了避免污染环境 先看看目录 在pip 是否分离source和build目录(输入y,选择分离...>项目语言[zh]: 创建文件C:\ Users \ yunswj \ Desktop \ Sphinx \ source \ conf.py。...这是生成的结构 build:用来存放通过make html生成文档网页文件的目录 source:存放用于生成文档的源文件 conf.py: Sphinx的配置文件 index.rst: 主文档 config.py...pip install recommonmark pip install sphinx_rtd_theme 安装好,在conf.py中修改下列两个配置: source_suffix = ['.rst'

    1.6K20

    Sphinx+gitee+Read the Docs搭建在线文档系统

    Sphinx是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统,相比github,有着更快的访问速度 Read the Docs是一个在线文档托管服务, 你可以各种版本控制系统中导入文档...1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx,在windows的命令行中输入下面的命令 pip install -i...这里先简单说明一下各个文件的作用: build:生成的文件的输出目录 source: 存放文档源文件 _static:静态文件目录,比如图片等 _templates:模板目录 conf.py:进行 Sphinx.../simple sphinx_rtd_theme 然后修改conf.py 文件,找到 html_theme 字段,修改为 #html_theme = 'alabaster' html_theme...然后,还要修改conf.py 文件,找到 extensions字段,修改为: #extensions = [ #] extensions = ['recommonmark','sphinx_markdown_tables

    1.9K30

    Sphinx补篇

    但是同一来源,它还可以生成LaTeX文件,也可以将其编译为文档的PDF版本,或者直接使用rst2pdf编译为PDF文件。 ?...#build-config 基本配置 之前提及我们使用 conf.py 脚本来控制 Sphinx 怎么处理文档....相关配置项已经由 sphinx-quickstart 在初始化时写入 conf.py (使用 Py 的标准注释 # 将一些备选项,事先注释了) 要修订对应配置,只要先消除对应行的注释,并修订参数值就好....想追加定制的参数,如果没由 sphinx-quickstart 预先生成,自个儿追加也就是了. 注意,要保持配置文件严格使用 Python 脚本语法,特别是 字串,数字,列表等等....如果有参数值使用非ASCII 字串,就得使用Python 的 Unicode 聲明形式(project = u'Exposé') ?

    1.2K10

    如何使用Sphinx记录Python代码【Programming(Python)】

    Sphinx与Tox一起,使得它易于编写,易于欣赏。 image.png Python代码可以在其源代码中包含文档。 这样做的默认方式依赖于docstrings ,它们以三引号格式定义。...使Python文档更漂亮 为了使您的文档看起来更漂亮,您可以利用Sphinx ,它旨在制作漂亮的Python文档。...这三个Sphinx扩展特别有用: sphinx.ext.autodoc :模块内部获取文档 sphinx.ext.napoleon :支持Google样式的文档字符串 sphinx.ext.viewcode...:将ReStructured Text源与生成的文档打包在一起 为了告诉Sphinx什么以及如何生成,我们在docs / conf.py中配置一个辅助文件: extensions = [ 'sphinx.ext.autodoc...我们可以docstrings开始,添加.rst文件,然后添加Sphinx和Tox为用户美化结果。 对于好的文档,您欣赏什么? 你还有其他喜欢的策略吗? 请在评论中分享它们!

    1.2K00

    Python利用sphinx构建个人博客

    新版的Python文档就是由Sphinx生成的,并且它已成为Python项目首选的文档工具,同时它对C/C++项目也有很好的支持;并计划对其它开发语言添加特殊支持。...Read the Docs是一个在线文档托管服务,可以各种版本控制系统中导入文档。支持webhooks,当你提交代码时,文档将被自动构建。...Linux release 7.3.1611 (Core) [root@xuel-server ~]# python --version Python 2.7.5 需要安装git 3.2 pip 安装...sphinx环境 pip install sphinx sphinx-autobuild sphinx_rtd_theme 3.3 初始化项目 mkdir /mywike && cd /mywiki sphinx-quickstart...Makefile #编译文件用 make 命令时,可以使用这些指令来构建文档输出 └── source #文件夹,文档源文件全部应全部放在source根目录下 ├── conf.py

    2.3K21

    ReadDocs

    搭建工具 Sphinx 是一个基于 Python 的文档生成工具,最早只是用来生成 Python 官方文档,随着工具的完善,越来越多的知名的项目也用他来生成文档,甚至完全可以用他来写书。...搭建步骤 pip install sphinx sphinx-autobuild sphinx_rtd_theme 新建一个Github仓库,并拉到本地,仓库名设为项目名。...命令行进入仓库本地目录,输入sphinx-quickstart 这个是项目的配置文件,这里要改动的是项目名,版本,以及语言。其他的默认即可。生成下面目录结构。...进入目录下面的conf.py,可以看到我们刚才的配置的内容就是在配置这个文件。下面继续修改。...参考文章 sphinx中文翻译手册 http://dwz.cn/wEwYNed3 https://www.jianshu.com/p/78e9e1b8553a

    1.2K20

    使用python编写量子线路打印的简单项目,并使用Sphinx自动化生成API文档

    技术背景 该文章一方面量子线路的打印着手,介绍了一个简单的python量子线路工程。同时基于这个简单的小工程,我们顺带的介绍了python的API文档自动化生成工具Sphinx的基本使用方法。...安装sphinx 这里我们直接使用python的包管理工具pip来安装Sphinx以及一个read_the_docs格式的python库。.... > 项目语种 [en]: en 创建文件 /home/dechin/projects/2021-quantum/circuit/source/conf.py。...26 qcprinter.py drwxr-xr-x 4 dechin dechin 4096 2月 23 00:04 source 在source目录下会产生一些配置文件,这里我们需要修改其中的conf.py...$ cd source/ [dechin@dechin-manjaro source]$ ll 总用量 16 -rw-r--r-- 1 dechin dechin 1884 2月 23 00:04 conf.py

    2.9K20
    领券